Planning Poker Backend

Frontend Repo

API Documentation

Setup

Clone backend repo into project directory

git clone git@github.com:SimonAlmers/planningpoker-be.git project

Create virtual environment

python3 -m venv env
source env/bin/activate

Change into the project directory

cd project

Add .env file in the root of the project dir

touch .env

Add env variables to .env file:

The value for the FIREBASE_URL will be explained in the Firebase Realtime Database Setup

export SECRET_KEY='***' # Generate Django Secret here:
export DATABASE_URL='postgres://[user]:[password]@localhost/[database_name]' # Postgres Database URL (not needed if using development- or test-settings which uses sqlite)
export FIREBASE_URL='***'

Install required packages:

pip install -r requirements.txt

Run migrations on your local database

python manage.py migrate --settings config.settings.development

Create a superuser to be able to login to the django admin.

python manage.py createsuperuser --settings config.settings.development

Collect static files

python manage.py collectstatic --settings config.settings.development

Spin up a development server on localhost port 8080

python manage.py runserver 0:8080 --settings config.settings.development

Visit the Django Admin

Django Admin

API Docs

Test

python manage.py test --settings config.settings.test

or

python manage.py test --pattern="test_*.py" --settings config.settings.test