Skip to content

Latest commit

 

History

History
99 lines (54 loc) · 2.33 KB

README.rst

File metadata and controls

99 lines (54 loc) · 2.33 KB
Raw

Theta Tau Chapter Management Tool

App for the Theta Tau Chapter Management Tool

Built with Cookiecutter Django

Black code style

License

GPLv3

Settings

Moved to settings.

Contributing

See the contributing instructions here: Contributing

Development Installation

See the installation instructions here: Installation

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 thetataucmt

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.

Docker

See detailed cookiecutter-django Docker documentation.