Awesome

New Django REST framework -based Webmark

WebMark2's documentation can be found from Wiki!

Read creation notes to see which files were modified or created to get this far from the previous version WebMark.

Environment

First of all, the environment variables have to be set. Make sure you have a file .env in the root of the project. The .env is also in the .gitignore. Make certain you don't push the file to GitHub.

Here is a sample .env:

RDEBUG=True

DJANGO_SECRET_KEY="See end of the file how to generate"

DATABASE_NAME=quantdb
DATABASE_USER=quantuser
DATABASE_PASSWORD=RandomChars
DATABASE_HOST=qleader-db
DATABASE_PORT=5432

GOOGLE_OAUTH2_KEY="Get from console.developers.google.com"
GOOGLE_OAUTH2_SECRET="Get from console.developers.google.com"

Setting up the development environment using Docker (recommended)

To install Docker and Docker-compose, follow the link to Docker cheat sheet. There are also basic instructions how to manage the project, such as, running, building, testing etc.

Testing

The testing documentation is in here.

Some useful commands

Lint

Lint your code with

flake8

Lint HTML templates with

curlylint templates/

Setting up the server without Docker

If you have made changes to the model then you need to update the database schema:

python manage.py makemigrations
python manage.py migrate

Start the server:

python manage.py runserver

Ctrl-C to terminate.

How to generate a secret key with python:__

python -c "import secrets; print(secrets.token_urlsafe())"