Small-Minds/Democracy-BE-V3

Democracy backend. Simple REST API for storing information about users, elections, candidates, and votes. Elastically deployable on AWS, DigitalOcean, Heroku, etc.

Democracy

SOURCE CODE COPYRIGHT (C) SMALL MINDS 2020

This repository contains the services/backend component to the Democracy system.

The Democracy project by Small Minds is designed to:

1. Provide a secure and fair voting system for small elections.
2. Give election runners the ability to easily manage a set of open positions.
3. Give candidates a simple way to run for any given position.
4. Ensure election runners can restrict applicants by email domain.
5. Use simple email verification to ensure users are part of any given org.

Frontend: Democracy-PWA-V3

Contributing

When adding new features, please use the semantic commit style with these labels:

• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• refactor: A code change that neither fixes a bug nor adds a feature
• perf: A code change that improves performance
• test: Adding missing or correcting existing tests
• chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Development

No matter the OS, you can simply type these two commands to build, run (with hot reloading,) and unit test the system:

# Build
docker-compose build

# Start/Develop
docker-compose up

# Run Unit Tests
docker-compose run django pytest --looponfail

In development, an artificial mailbox can be found at http://127.0.0.1:8025/. All dev emails are directed here.

Structure

User
  => First/Last Name
  =>
  => [Email Addresses]
  => Elections  (Elections the User owns.)

Election
  => [Email Domains]
  => Multiple_Applications: boolean
  => Application_Start_Time: date
  => Application_End_Time: date
  => Voting_Start_Time: date
  => Voting_End_Time: date
  => Positions: Position[]

Position
  => Title: string
  => Description: string
  => Candidates: Candidate[]

Candidate
  => User: User
  => Platform: string

FUBAR

If nothing works, use docker system prune --all --force --volumes to kill everything.

Heroku Access

To get to BASH in Heroku, download the CLI and use the following command:

heroku run -a sm-democracy-v1 bash

Deployment

Easy mode: Fork the repository and deploy to Heroku. Deploy the frontend to Netlify.

Add free tiers of Postgres, Redis, Sentry, and your logger of choice (PaperTrail?)

Register for AWS SES to deliver emails to your voting demographic.

Add the following environment variables to Heroku (some of them will be added automatically):

AWS_ACCESS_KEY_SES=AKA...
AWS_SECRET_KEY_SES=4nQ...
CORS_ALLOWED_ORIGINS=https://app.herokuapp.com,https://democracy.abce.fg
DEBUG_COLLECTSTATIC=FALSE
DJANGO_ADMIN_URL=admin/gm...sdqk/
DJANGO_DEBUG=False
DJANGO_SECRET_KEY=Fy90k
DJANGO_SETTINGS_MODULE=config.settings.production
PYTHONHASHSEED=random
USE_DOCKER=False
DJANGO_ALLOWED_HOSTS=sm-democracy-v1.herokuapp.com,democracy.smallminds.dev
FRONTEND_URL=https://democracy.smallminds.dev

DATABASE_URL=postgres://uuxcdrl...
REDIS_TLS_URL=rediss://:p48byxee...
REDIS_URL=redis://:p48byc...

You'll need to login to the app with heroku CLI to make an administrator account.

Backup or Restore Database Dump

https://devcenter.heroku.com/articles/heroku-postgres-import-export

You'll need to paste the password from the docker compose configs when prompted.

PS X:\backup\location\>
pg_restore --verbose --clean --no-acl --no-owner -d <destination> -U <username> -d democracy .\latest.dump

Standards

Pre-Commit is used to enforce code style.

# Everywhere Sane
pre-commit run --all

# On Windows
pyenv exec pre-commit run --all

New DB Parameters

docker-compose run django python manage.py makemigrations
docker-compose run django python manage.py migrate