From 58071b5d1dfbe5961a782d6dcf92dd2e21519b4e Mon Sep 17 00:00:00 2001 From: Ayo Ayco Date: Mon, 8 Apr 2024 13:26:08 +0000 Subject: [PATCH] chore: update dev instructions on readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b443fb1..0435580 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ ## Background Yet another rewrite of my [personal site](https://ayo.ayco.io) -## Set up -1. Install Flask and dependencies. The following are the steps for MacOS/Linux: +## Set up -- needs Linux +1. Install dependencies 1. create python environment: `python3 -m venv .venv` 2. activate python env: `. .venv/bin/activate` 3. install wheel: `pip install wheel` 4. install gunicorn & flask: `pip install gunicorn 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 + 1. allow port usage: `sudo ufw allow 5000` + 2. run the development server: `python api.py`` 3. After development session, deactivate the python env with: `deactivate`