diff --git a/README.md b/README.md new file mode 100644 index 0000000..e7d5d8e --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# Ayo Ayco's personal site built with Flask + +## Set up +1. [Install Flask and dependencies](https://flask.palletsprojects.com/en/3.0.x/installation/). The following are the steps for MacOS/Linux: + 1. create python environment: `python3 -m venv .venv` + 2. activate python env: `. .venv/bin/activate` + 3. install Flask: `pip install Flask` +2. To start development: + 1. Set environment variable for the flask app entry point with `export FLASK_APP=api.py` + 2. run the development server: `flask run`; note that the default port (5000) needs to be open +3. After development session, deactivate the python env with: `deactivate`