contentdb/README.md

65 lines
1.3 KiB
Markdown
Raw Normal View History

2018-03-19 19:25:13 +01:00
# Content Database
## Setup
First create a Python virtual env:
2018-03-24 20:12:02 +01:00
virtualenv env -ppython3
2018-03-19 19:25:13 +01:00
source env/bin/activate
then use pip:
2018-03-20 01:44:47 +01:00
pip3 install -r requirements.txt
2018-03-19 19:25:13 +01:00
2018-03-24 20:12:02 +01:00
### 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
2018-03-19 19:25:13 +01:00
## Running
2018-03-24 20:12:02 +01:00
### Development
2018-03-19 19:25:13 +01:00
You need to enter the virtual environment if you haven't yet in
the current session:
source env/bin/activate
2018-03-24 20:12:02 +01:00
If you need to, reset the db like so:
2018-03-19 19:25:13 +01:00
2018-05-27 21:15:35 +02:00
python3 setup.py -t
2018-03-19 19:25:13 +01:00
Then run the server:
2018-03-24 20:12:02 +01:00
./rundebug.py
2018-03-19 19:25:13 +01:00
2018-03-21 22:17:10 +01:00
Then view in your web browser: http://localhost:5000/
## How-tos
2018-05-27 21:15:35 +02:00
### Start celery worker
```sh
FLASK_CONFIG=../config.cfg celery -A app.tasks.celery worker
```
### Create migration
```sh
# if sqlite
python setup.py -t
rm db.sqlite && python setup.py -t && FLASK_CONFIG=../config.cfg FLASK_APP=app/__init__.py flask db stamp head
# Create migration
FLASK_CONFIG=../config.cfg FLASK_APP=app/__init__.py flask db migrate
# Run migration
FLASK_CONFIG=../config.cfg FLASK_APP=app/__init__.py flask db migrate
```