Skip to content

Latest commit

 

History

History
70 lines (39 loc) · 2.53 KB

README.md

File metadata and controls

70 lines (39 loc) · 2.53 KB
Raw

iPeM Webapp

Webapp to explain iPeM, including its methods and abstraction levels.

Built with Cookiecutter Django Black code style

License: MIT

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 a 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.

Creating a new app

  1. Create the app with:

     $ python manage.py startapp <name-of-the-app>

  2. Move directory to ipem_webapp directory

  3. Edit ipem_webapp//apps.py and change name = "" to name = "ipem_webapp."

  4. Add "ipem_webapp." to LOCAL_APPS in config/settings/base.py

Type checks

Running type checks with mypy:

$ mypy ipem_webapp

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 pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.