diff --git a/Development-setup-%28Windows%29.md b/Development-setup-%28Windows%29.md new file mode 100644 index 0000000..aa41e34 --- /dev/null +++ b/Development-setup-%28Windows%29.md @@ -0,0 +1,12 @@ +# Quick n dirty + +- after cloning, run `py -3 -m venv .venv` in the root directory and then `.venv\Scripts\activate` +- then `pip install Flask` inside the virtual env +- you might also need to init a database, so use `flask --app myriad init-db` +- to start the site use `flask --app myriad run --debug` + +do not deploy this way, the packaged flask server is not secure. production instructions will be provided when the project is ready + +- you will need to run `.venv\Scripts\activate` from the folder every time you start working on it +- re-building the entire database with `flask --app myriad init-db` (losing all the data inside) will be necessary as development continues. DO NOT STORE ANYTHING IMPORTANT DURING DEVELOPMENT +- start the site with `flask --app myriad run --debug` as usual \ No newline at end of file