Care

Care is a Corona Care Center management app for the Govt of Kerala

License:	MIT

Set up Local environment

Follow the steps listed here.

If you are installing PostgreSQL for the first time, follow the steps given in this answer.

You also might have to install PostGIS scripts.

• Linux users can install PostGIS scripts by running

  $ sudo apt install postgresql-<version>-postgis-scripts
  

• Windows users can install PostGIS through Application Stack Builder which is installed along PostgreSQL using standard PostgreSQL installer.

Setting up Pre-Commit

Git hooks is a feature which helps to fix small issues in your code before you commit the code. Pre-Commit is a package manager and tool for running and organising your git hooks. More here at pre_commit_site.

• Install pre-commit

  pre-commit is installed while you run pip install requirements.txt

• Setup

  this installs all the git-hooks

  $ pre-commit install
  

• Running pre-commits

  The git hooks run every time you commit code to the repo. If you want to run it before committing, use the following command

  $ pre-commit run --all-files
  

• FAQs and Issues with pre-commit

  • Reach out on the #coronasafe_django channel in slack to resolve the issues.

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 care

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.

Email Server

In development, it is often nice to be able to see emails that are being sent from your application. If you choose to use MailHog when generating the project a local SMTP server with a web interface will be available.

1. Download the latest MailHog release for your OS.

2. Rename the build to MailHog.

3. Copy the file to the project root.

4. Make it executable:

   $ chmod +x MailHog
   

5. Spin up another terminal window and start it there:

   ./MailHog
   

6. Check out http://127.0.0.1:8025/ to see how it goes.

Now you have your own mail server running locally, ready to receive whatever you send it.

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.

Heroku

See detailed cookiecutter-django Heroku documentation.