Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/raksha-life/rescuekerala

Website for coordinating rehabilitation of people affected in the Kerala Floods
https://github.com/raksha-life/rescuekerala

community crowdsourcing django flood hacktoberfest help open-source python rescue

Last synced: 3 months ago
JSON representation

Website for coordinating rehabilitation of people affected in the Kerala Floods

Awesome Lists containing this project

README 

        
KeralaRescue



[![Build Status - Travis][0]][1] [![Open Source Helpers](https://www.codetriage.com/ieeekeralasection/rescuekerala/badges/users.svg)](https://www.codetriage.com/ieeekeralasection/rescuekerala)



The Website for co-ordinating the rehabilitation of the people affected in the Kerala Floods.



[![Join Kerala Rescue Slack channel](https://i.imgur.com/V7jxjak.png)](http://bit.ly/rebuildearth)



## Table of Contents

- [Requirements](#requirements)

    - [Docker](#docker)

    - [Python 3](#python-3)

    - [Postgres](#postgres)

    - [Git](#git)

    - [Redis](#redis)

    - [Setting up an S3 Account](#setting-up-an-s3-account)

- [Getting started](#getting-started)

    - [Setting up a development environment](#setting-up-a-development-environment)

    - [Setup using docker-compose](#setup-using-docker-compose)

- [Creating migration files](#creating-migration-files)

- [Running tests](#running-tests)

- [Enable HTTPS connections](#enable-https-connections)

- [How can you help?](#how-can-you-help)

    - [Verification of Rescue Requests](#verification-of-rescue-requests)

    - [Contribution Guidelines](#contribution-guidelines)

    - [Testing PRs](#by-testing)

    - [Submitting PRs](#submitting-pull-requests)






### Requirements

[^top](#table-of-contents)



#### Docker

- Check out this [Wiki](https://github.com/raksha-life/rescuekerala/wiki/Using-Docker) to see how to run docker for this project.



#### [Python 3](https://www.python.org/downloads/)



#### [Postgres](https://www.postgresql.org/download/)



#### [Git](https://git-scm.com/downloads)



#### [Redis](https://redis.io/)



#### Setting up an S3 Account



- Follow https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html and https://www.caktusgroup.com/blog/2014/11/10/Using-Amazon-S3-to-store-your-Django-sites-static-and-media-files/ to setup s3 bucket, and download access keys.






### Getting Started

[^top](#table-of-contents)



### Setting up a development environment



1. Create database and user in Postgres for keralarescue and give privileges. 



    psql user=postgres

    Password:

    psql (10.4 (Ubuntu 10.4-0ubuntu0.18.04))

    Type "help" for help.



    postgres=# CREATE DATABASE rescuekerala;

    CREATE DATABASE

    postgres=# CREATE USER rescueuser WITH PASSWORD 'password';

    CREATE ROLE

    postgres=# GRANT ALL PRIVILEGES ON DATABASE rescuekerala TO rescueuser;

    GRANT

    postgres=# \q



2. Clone the repo.



    git clone https://github.com/raksha-life/rescuekerala.git

    cd rescuekerala



3. Copy the sample environment file and configure it as per your local settings.



        cp .env.example .env



> Note: If you cannot copy the environment or you're facing any difficulty in starting the server, copy the settings file from

https://github.com/vigneshhari/keralarescue_test_settings for local testing.



4. Install dependencies.

    

```

pip3 install -r requirements_debug.txt

```



    



5. Run database migrations.



        python3 manage.py migrate



6. Setup static files.



        python3 manage.py collectstatic



7. Run the server.



        python3 manage.py runserver



8. Now open localhost:8000 in the browser

That's it!






### Setup using docker-compose

#### Pre-requisites

* [Docker](https://docs.docker.com/install/)

* [Docker Compose](https://docs.docker.com/compose/install/)



Run the scripts in the root directory



* `docker-start.sh` - to start the services. 



* `docker-stop.sh` - to stop the services. 



* `docker-restart.sh` - to rebuild and restart the services. 



### Creating migration files

[^top](#table-of-contents)



If your code changes anything in models.py, you might need to make changes in database schema, or other constraints. To create migrations files, run python3 manage.py makemigrations --settings=floodrelief.settings after making your changes. Also make sure to add these files in the commit.



### Running tests

[^top](#table-of-contents)



When running tests, Django creates a test replica of the database in order for the tests not to change the data on the real database. Because of that, you need to alter the Postgres user that you created and add to it the `CREATEDB` privilege:



```

ALTER USER rescueuser CREATEDB;

```



To run the tests, run this command:



```

python3 manage.py test --settings=floodrelief.test_settings

```






### Enable HTTPS connections

[^top](#table-of-contents)



Certain features (example: GPS location collection) only work with HTTPS connections.  To enable HTTPS connections,follow the below steps.



Create self-signed certificate with openssl



```

$openssl req -x509 -newkey rsa:4096 -keyout key.key -out certificate.crt -days 365 -subj '/CN=localhost' -nodes

```

[https://stackoverflow.com/questions/10175812/how-to-create-a-self-signed-certificate-with-openssl#10176685]



Install django-sslserver



```

$pip3 install django-sslserver

```



Update INSTALLED_APPS with sslserver by editing the file floodrelief/settings.py (diff below)



```diff

 INSTALLED_APPS = [

+    'sslserver',

     'mainapp.apps.MainappConfig',

     'django.contrib.admin',

```

#### Note: Make sure that this change is removed before pushing your changes back to git

Run the server



```

python3 manage.py runsslserver 10.0.0.131:8002  --certificate /path/to/certificate.crt --key /path/to/key.key

```

In the above example the server is being run on a local IP address on port 8002 to enable HTTPS access from mobile/laptop/desktop for testing.






## How can you help?

[^top](#table-of-contents)



#### Verification of Rescue Requests



You can help us with verifying user submitted request from our [Ushahidi volunteer](https://volunteers.keralarescue.in/) portal. Please follow the usermanual available in either [English](https://github.com/raksha-life/rescuekerala/files/2300176/Kerala.Rescue.Volunteers.Manual.Draft.pdf) or [Malayalam](https://github.com/raksha-life/rescuekerala/files/2299875/default.pdf)



#### Contribution Guidelines

Check out this [Wiki](https://github.com/raksha-life/rescuekerala/wiki/Contribution-Guidelines) for our contribution guidelines.



Please find issues that we need help [here](https://github.com/raksha-life/rescuekerala/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). Go through the comments in the issue to check if someone else is already working on it. Don't forget to drop a comment when you start working on it.



Testing PRs



We have a lot of [Pull Requests](https://github.com/raksha-life/rescuekerala/pulls) that requires testing. Pick any PR that you like, try to reproduce the original issue and fix. Also join `#testing` channel in our slack and drop a note that you

are working on it.



#### Testing Pull Requests

Note: If you have cloned a fork of raksha-life/rescuekerala, replace ```origin``` with ```upstream```



1. Checkout the Pull Request you would like to test by

      ```

      git fetch origin pull/ID/head:BRANCHNAME`

      git checkout BRANCHNAME

     ```

2. Example

    ```

    git fetch origin pull/406/head:jaseem

    git checkout jaseem1

    ```

3. Run Migration



Submitting Pull Requests



Please find issues that we need help [here](https://github.com/raksha-life/rescuekerala/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). Go through the comments in the issue to check if someone else is already working on it. Don't forget to drop a comment when you start working on it.



Always start your work in a new git branch. **Don't start to work on the

master branch**. Before you start your branch make sure you have the most

up-to-date version of the master branch then, make a branch that ideally

has the bug number in the branch name.



1. Before you begin, Fork the repository. This is needed as you might not have permission to push to the main repository



2. If you have already clone this repository, create a remote to track your fork by

     ```

     git remote add origin2 [email protected]:tessie/rescuekerala.git

     ```

3. If you have not yet cloned, clone your fork

    ```

    git clone [email protected]:tessie/rescuekerala.git

    ```

4. Checkout a new branch by

     ```

     git checkout -b issues_442

     ```

4. Make your changes.



5. Ensure your feature is working as expected.



6. Push your code.

      ```

      git push origin2 issues_442

      ```

7. Compare and create your pull request.



[0]: https://travis-ci.org/raksha-life/rescuekerala.svg?branch=master

[1]: https://travis-ci.org/raksha-life/rescuekerala






### Flood Map

You can find the repo for the Flood Map here : https://github.com/aswinmohanme/kerala-flood-map