Fix migration error when migrating from scratch

[cheatdb.git] / README.md

diff --git a/README.md b/README.md
index 155d27141171f9c537b38e079f05b45e7d972a7c..7943bad511e83a959beb69337cbeacd8e4d62d16 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,27 +1,110 @@
 # Content Database
+[![Build status](https://gitlab.com/minetest/contentdb/badges/master/pipeline.svg)](https://gitlab.com/minetest/contentdb/pipelines)
 
-Content database for Minetest mods, games, and more.
-
+Content database for Minetest mods, games, and more.\
 Developed by rubenwardy, license GPLv3.0+.
 
-## How-tos
+## Getting started (debug/dev)
 
-Note: you should first read one of the guides on the [Github repo wiki](https://github.com/minetest/contentdb/wiki)
+Docker is the recommended way to develop and deploy ContentDB.
 
-```sh
-# Run celery worker
-FLASK_CONFIG=../config.cfg celery -A app.tasks.celery worker
+1. Install `docker` and `docker-compose`.
+
+               sudo apt install docker-ce docker-compose
+
+1. Copy `config.example.cfg` to `config.cfg`.
+
+2. Fill out `config.cfg`
+       1. Set `SQLALCHEMY_DATABASE_URI` = "postgres://contentdb:password@db:5432/contentdb"
+       2. Optionally, set the MAIL settings.
+
+3. (Optional) Set up GitHub integration
+       1. Make a Github OAuth Client at <https://github.com/settings/developers>:
+       2. Homepage URL - `http://localhost:5123/`
+       3. Authorization callback URL - `http://localhost:5123/user/github/callback/`
+       4. Put client id and client secret in `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET` in config.cfg.
+
+4. Create config.env:
+
+               POSTGRES_USER=contentdb
+               POSTGRES_PASSWORD=password
+               POSTGRES_DB=contentdb
+               FLASK_DEBUG=1
+
+5. Start docker images:
+
+               docker-compose up --build
+
+6. Setup database:
+
+               ./utils/run_migrations.sh
+
+8. (Optional) create initial data
+       1. `./utils/bash.sh`
+       2. Either `python setup.py -o` or `python setup.py -t`
+       1. `-o` creates just the admin, and static data like tags, and licenses.
+       2. `-t` will create test pacakges.
+
+9.  View at <http://localhost:5123>.
+    The admin username is `rubenwardy` and the password is `tuckfrump`.
+
+In the future, starting CDB is as simple as:
 
-# if sqlite
-python utils/setup.py -t
-rm db.sqlite && python setup.py -t && FLASK_CONFIG=../config.cfg FLASK_APP=app/__init__.py flask db stamp head
+       docker-compose up --build
 
-# Create migration
-FLASK_CONFIG=../config.cfg FLASK_APP=app/__init__.py flask db migrate
+To hot/live update CDB whilst it is running, use:
 
-# Run migration
-FLASK_CONFIG=../config.cfg FLASK_APP=app/__init__.py flask db upgrade
+       ./utils/reload.sh
+
+This will only work with python code and templates, it won't update tasks or config.
+
+
+## How-tos
+
+```sh
+# Hot/live reload (only works with FLASK_DEBUG=1)
+./utils/reload.sh
+
+# Cold update a running version of CDB with minimal downtime (production)
+./utils/update.sh
 
 # Enter docker
-docker exec -it contentdb_app_1 bash
+./utils/bash.sh
+
+# Run migrations
+./utils/run_migrations.sh
+
+# Create new migration
+./utils/create_migration.sh
+```
+
+## Database
+
+
+```mermaid
+classDiagram
+
+User "1" --> "*" Package
+User --> UserEmailVerification
+User "1" --> "*" Notification
+Package "1" --> "*" Release
+Package "1" --> "*" Dependency
+Package "1" --> "*" Tag
+Package "1" --> "*" MetaPackage : provides
+Release --> MinetestVersion
+Package --> License
+Dependency --> Package
+Dependency --> MetaPackage
+MetaPackage "1" --> "*" Package
+Package "1" --> "*" Screenshot
+Package "1" --> "*" Thread
+Thread "1" --> "*" Reply
+Thread "1" --> "*" User : watchers
+User "1" --> "*" Thread
+User "1" --> "*" Reply
+User "1" --> "*" ForumTopic
+
+User --> "0..1" EmailPreferences
+User "1" --> "*" APIToken
+APIToken --> Package
 ```