README.md

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.

License : MIT

Setup

1. Clone the repository

   $ git clone https://github.com/Podnet/Fight-Covid19

2. Create a virtual environment using virtualenv or venv.

   $ virtualenv -p python3 venv/ 
   $ source venv/bin/activate

3. Install python packages

   $ pip3 install -r requirements/local.txt

4. Install OS dependencies (For linux systems only, others have to install it manually)

   $ sudo ./utility/install\_os\_dependencies.sh install

5. Setup Postgres database (assuming you have already installed it)

   $ sudo -i -u postgres 
   $ createdb fight_covid19 
   $ createuser --interactive 
   Enter name of role to add: <username>
   Shall the new role be a superuser? (y/n) y

6. Point django to the database instance. Create a .env file with the following content:

   # These variables are used locally
   DATABASE_NAME="postgres:///fight_covid19" 
   DATABASE_USER="apoorva"
   DATABASE_PASSWORD="apple007" 
   DATABASE_HOST="127.0.0.1" 
   DATABASE_PORT="5432"

   $ touch .env
   $ nano .env
   <paste the contents of the file>

7. Run project locally

   $ python manage.py runserver

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.

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.

API Endpoints

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

Issues

// No Issues now.

NOTE: Feel free to open issues. Make sure you follow the Issue Template provided.

Contribution Guidelines

• Write clear meaningful git commit messages (Do read this).

• Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (Check this for more info)

• When you make very very minor changes to a PR of yours (like for example fixing a text in button, minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at here)

• When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker.

• Please follow the PR Template to create the PR.

• Always create PR to develop branch.

• Please read our Code of Conduct.

• Refer this for more.