justinrporter / stl-dsa

Repo for the STL DSA website

STL DSA

Website for the St Louis chapter of the Democratic Socialists of America

License:	MIT

Setting Up Your Local Environment

1. Make sure you have postgresql installed and in psql run CREATE DATABASE stl_dsa (note the underscore)
2. Create a virtualenv (I use virtualenv wrapper) and cd into the virtual environment. Python version must be 3.7 or higher. To specify a python version with virtualenvwrapper, use mkvirtualenv -p [path/to/python/version] [name-of-environment]
3. pip install -r requirements/local.txt
4. python manage.py makemigrations
5. python manage.py migrate
6. python manage.py runserver

Settings

Moved to settings.

Basic Commands

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create an superuser account, use this command:

  $ python manage.py createsuperuser
  

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

$ mypy stl_dsa

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with py.test

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.