From 50d4a8634f134c0d5276f7ed65d06fa9ddbf03a7 Mon Sep 17 00:00:00 2001 From: Matt Arnold Date: Wed, 16 Apr 2025 11:26:37 -0400 Subject: Documentation fixes and blerg --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 57 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0d71c94..a093aa3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,62 @@ **Where all your vibes live** -A forum engine in progress. Do not use in production. Run ./migrate.py install and follow the prompts. +A forum engine in progress. Do not use in production. Run ./migrate.py install and follow the prompts. Full install instructions below. It needs everything, posting, and reply works! So it can be hacked on further 😅 + +# Full install instructions + +## step 1 +If you've never done python before.. Python projects live inside little boxes call virtual envs. To set one up for this project. Do + +```shell +python -m venv venv +``` +That will set up a virtual env in the customary place. To use it +## step 2 +```shell +source ./venv/bin/activate +``` +## step 3 +Then you install the dependencies like so +```shell +pip install -r requirements.txt +``` +## step 4 +Next run migrate install, and follow all the prompts +```shell +./migrate.py install +``` +## step 5 +Finally boot app.py + +```shell +./app.py +``` +It will setup a listener on port 5052 + + +## step 6 + +When done playing exit the app server by pressing ctrl-c then run +```shell +deactivate +``` + +# stuff to do on a git pull + +```shell +./migrate.py upgrade-schema +pip install -r requirements.txt +``` + + +# known bugs + + +The app server will invalidate your cookies on every make a change, and reload. as it regenerates the secret key used for session signing every time it restarts with stat. +I will fix this eventually. + + +Thus endith the instructions \ No newline at end of file -- cgit 1.4.1-2-gfad0