ayo/ayco.io-flask
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update dev instructions on readme

Browse source
This commit is contained in:
Ayo Ayco 2024-04-08 13:26:08 +00:00
parent a926f85326
commit 58071b5d1d
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -3,13 +3,13 @@
## Background ## Background
Yet another rewrite of my [personal site](https://ayo.ayco.io) Yet another rewrite of my [personal site](https://ayo.ayco.io)
## Set up ## Set up -- needs Linux
1. Install Flask and dependencies. The following are the steps for MacOS/Linux: 1. Install dependencies
1. create python environment: `python3 -m venv .venv` 1. create python environment: `python3 -m venv .venv`
2. activate python env: `. .venv/bin/activate` 2. activate python env: `. .venv/bin/activate`
3. install wheel: `pip install wheel` 3. install wheel: `pip install wheel`
4. install gunicorn & flask: `pip install gunicorn flask` 4. install gunicorn & flask: `pip install gunicorn flask`
2. To start development: 2. To start development:
1. Set environment variable for the flask app entry point with `export FLASK_APP=api.py` 1. allow port usage: `sudo ufw allow 5000`
2. run the development server: `flask run`; note that the default port (5000) needs to be open 2. run the development server: `python api.py``
3. After development session, deactivate the python env with: `deactivate` 3. After development session, deactivate the python env with: `deactivate`