diff --git a/README.md b/README.md index 7943bad..55aedd9 100644 --- a/README.md +++ b/README.md @@ -12,19 +12,17 @@ Docker is the recommended way to develop and deploy ContentDB. sudo apt install docker-ce docker-compose -1. Copy `config.example.cfg` to `config.cfg`. +2. 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 mail in config.cfg. -3. (Optional) Set up GitHub integration +4. (Optional) Set up GitHub integration 1. Make a Github OAuth Client at : 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: +5. Create config.env: POSTGRES_USER=contentdb POSTGRES_PASSWORD=password @@ -39,14 +37,14 @@ Docker is the recommended way to develop and deploy ContentDB. ./utils/run_migrations.sh -8. (Optional) create initial data +8. (Recommended, 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. + 1. `-o` creates just the admin, and static data like tags, and licenses. + 2. `-t` will do `-o` and also create test pacakges. (Recommended) -9. View at . - The admin username is `rubenwardy` and the password is `tuckfrump`. +9. View at . + The admin username is `rubenwardy` and the password is `tuckfrump`. In the future, starting CDB is as simple as: @@ -78,6 +76,41 @@ This will only work with python code and templates, it won't update tasks or con ./utils/create_migration.sh ``` + +### VSCode: Setting up Linting + +* (optional) Install the [Docker extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) +* Install the [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) + * Click no to installing pylint (we don't want it to be installed outside of a virtual env) +* Set up a virtual env + * Replace `psycopg2` with `psycopg2_binary` in requirements.txt (because postgresql won't be installed on the system) + * `python3 -m venv env` + * Click yes to prompt to select virtual env for workspace + * Click yes to any prompts about installing pylint + * `source env/bin/activate` + * `pip install -r requirements` + * `pip install pylint` (if a prompt didn't appear) + * Undo changes to requirements.txt + +### VSCode: Material Icon Folder Designations + +```json +"material-icon-theme.folders.associations": { + "packages": "", + "tasks": "", + "api": "", + "meta": "", + "blueprints": "routes", + "scss": "sass", + "flatpages": "markdown", + "data": "temp", + "migrations": "archive", + "textures": "images", + "sounds": "audio" +} +``` + + ## Database