backend/README.md

1.2 KiB

exhauster analytics

A platform to process masive amount of information and prt it in preatty way

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.

Runserver

$ ./manage.py runserver_plus

Run consumer

$ python3 consumer.py

Type checks

Running type checks with mypy:

$ mypy exhauster_analytics

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

Deployment

The following details how to deploy this application.