mei-friend running within a browser
- Go to https://github.com/settings/developers
- Click on "Register a new application"
- Enter application name = "mei-friend"
- Enter homepage = "https://iwk.mdw.ac.at"
- Enter callback URL = "http://localhost:4000/authorize"
- Click "Register application"
- Click "Generate a client secret" and log in if necessary
- Retain this page for configuration in the next steps:
git clone [email protected]:wergo/mei-friend-onlinecd mei-friend-onlinecp env-template .env- Edit .env to add in CLIENT_ID and SECRET_ID from the Github OAuth application
- Add a random hard to guess string as FLASK_SECRET
- If required, add a REDIRECT_URL to override the flask url_for("authorize") route in deployment
- If required, add STATIC_URL_PATH and/or STATIC_FOLDER to override the Flask defaults in deployment
- For development mode, set FLASK_ENV to "development" => do not deploy in development mode!
- For deployment, unset FLASK_APP. This will cause wsgi.py to be used instead.
- Run
python -m venv venv(if your system python is not python 3, runpython3 -m venv venv) - Run
. venv/bin/activate. Your prompt should update to show (venv) at the start - Run
pip install -r requirements.txt - Download CodeMirror 5.x from https://codemirror.net/
- Extract it and put it into app/static with directory name 'CodeMirror'
. venv/bin/activateflask run
- Use wsgi and gunicorn (instructions tbc)