4
Development setup (Windows)
cube edited this page 2026-05-09 13:05:59 +00:00

Quick n dirty

  • after cloning, run py -3 -m venv .venv in the root directory
  • and then .venv\Scripts\activate to activate the virtual environment
  • on windows you might need to do Set-ExecutionPolicy Unrestricted -Force first and then activate the virtual environment
  • then pip install Flask inside the virtual env
  • create instance folder, and create config.py file inside. paste in the default config from the readme
  • 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