A fork of the original contentdb, codenamed "Okapi".
Go to file
rubenwardy 968fd29bad
Fix crash on package query
2018-05-25 20:06:35 +01:00
app Fix crash on package query 2018-05-25 20:06:35 +01:00
migrations Fix migration error 2018-05-25 19:08:29 +01:00
.gitignore Move static and uploads to public dir 2018-05-23 21:15:21 +01:00
LICENSE.txt Update README 2018-03-24 19:12:02 +00:00
README.md Add dependency support to Edit Requests 2018-05-25 17:41:16 +01:00
config.example.cfg Move static and uploads to public dir 2018-05-23 21:15:21 +01:00
requirements.txt Add Flask migrations 2018-05-23 17:59:24 +01:00
rundebug.sh Use bash script to start server 2018-03-24 02:36:14 +00:00
runprod.sh Use bash script to start server 2018-03-24 02:36:14 +00:00
runprodguni.sh Create runproguni.sh 2018-05-23 21:02:37 +01:00
setup.py Add -t option to populate with test values, hide suggest changes button 2018-05-23 17:40:15 +01:00

README.md

Content Database

Setup

First create a Python virtual 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

If you need to, reset the db like so:

python3 setup.py -d

Then run the server:

./rundebug.py

Then view in your web browser: http://localhost:5000/

How-tos

Create migration

# 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