Add README

Signed-off-by: Alek Ratzloff <alekratz@gmail.com>
This commit is contained in:
2020-01-15 20:19:54 -05:00
parent a61ad46b49
commit 4b9f6b30f6

14
README.md Normal file
View File

@@ -0,0 +1,14 @@
# Market
Market simulator.
Details coming soon...
# Running
1. Install pipenv with `pip3 install --user pipenv` (make sure `$HOME/.local/bin` is in your `PATH`!)
2. Run `pipenv run ./local-manage.sh migrate` to create a local database
3. Run `pipenv run ./local-manage.sh createsuperuser` to create a superuser.
4. Run `pipenv run ./local-manage.sh runserver` to run a local server.
Navigate to the address given to you in the terminal, and log in from there.