Rename mod to package, add README

This commit is contained in:
rubenwardy
2018-03-19 18:25:13 +00:00
parent 358fc4e5da
commit ae600582a0
4 changed files with 38 additions and 7 deletions

31
README.md Normal file
View File

@@ -0,0 +1,31 @@
# Content Database
## Setup
First create a Python virtual env:
virtualenv env
source env/bin/activate
then use pip:
pip install -r requirements.txt
## Running
You need to enter the virtual environment if you haven't yet in
the current session:
source env/bin/activate
Reset the database like so:
python setup.py -d
Then run the server:
python rundebug.py
Then view in your web browser:
http://localhost:5000/