Skip to content

Latest commit

 

History

History
114 lines (69 loc) · 2.94 KB

README.rst

File metadata and controls

114 lines (69 loc) · 2.94 KB
Raw

Health of India: Fight Covid19

An application to map symptomatic patients of covid19 on map and collect continuous health updates from individuals. Visit covid19.thepodnet.com.

Built with Cookiecutter Django Black code style
License:MIT

Setup

  1. Clone the repository
  2. Create a virtual environment using virtualenv or venv.
  3. Install python packages
  4. Install OS dependencies
  5. Run project locally

Todo

  1. Update this README docs to post instructions for installation
  2. Tasks to perform
  3. Optimizations to perform on database

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 fight_covid19

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.

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

API Endpoints

  • users : GET,PUT : Details of users registered
  • healthentry : GET,POST,PUT : Entry by the users
  • coronacases : GET : Total Cases of Corona
  • healthstat : GET : Health Stats generated by us