From 873d029f25f893ce5b87d478cfba4ea5baa341d5 Mon Sep 17 00:00:00 2001 From: Tait Hoyem Date: Mon, 10 Jan 2022 17:47:59 -0700 Subject: [PATCH] update readme with detailed dev instructions --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 9fc220d..aa56ee8 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,27 @@ This is my lamegames repository. It has a lot of lame games, lol! +## Run Locally + +To run a local instance, you will need to run the following commands after `cd`ing yourself into the lamegames repo; $ represents a command, # is a comment: + +```bash +# create a virtual environment (aka install dependencies locally, instaed of system-wide) +$ python -m venv env +# activate virtual environment (use local dependencies instaed of system-wide dependencies) +$ source env/bin/activate +# install dependencies +$ pip install -r requirements.txt +# run django migrations (setup database) +$ python manage.py makemigrations +$ python manage.py migrate +# start redis (install it first, if you don't have it) +$ systemctl start redis +# start django app +$ python manage.py runserver +# now access at http://localhost:8000/ woot woot! +``` + ## How to add a game: See `/skel/README.md`