Update README
This commit is contained in:
19
README.md
19
README.md
@@ -4,26 +4,39 @@
|
||||
|
||||
First create a Python virtual env:
|
||||
|
||||
virtualenv env
|
||||
virtualenv env -ppython3
|
||||
source env/bin/activate
|
||||
|
||||
then use pip:
|
||||
|
||||
pip3 install -r requirements.txt
|
||||
|
||||
### Development
|
||||
|
||||
* Copy config.example.cfg to config.cfg
|
||||
* Fill SECRET_KEY and WTF_CSRF_SECRET_KEY in with a random string
|
||||
* Make a Github OAuth Client at <https://github.com/settings/developers>:
|
||||
* Homepage URL - `http://localhost:5000/`
|
||||
* Authorization callback URL - `http://localhost:5000/user/github/callback/`
|
||||
* Put client id and client secret in GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET
|
||||
* Setup the database: python3 setup.py
|
||||
|
||||
|
||||
## Running
|
||||
|
||||
### Development
|
||||
|
||||
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:
|
||||
If you need to, reset the db like so:
|
||||
|
||||
python3 setup.py -d
|
||||
|
||||
Then run the server:
|
||||
|
||||
python3 rundebug.py
|
||||
./rundebug.py
|
||||
|
||||
Then view in your web browser: http://localhost:5000/
|
||||
|
||||
Reference in New Issue
Block a user