iReporter

A system for reporting any form of corruption to the appropriate authorities and seeking for government intervention on important issues.

Available Endpoints:

Http Method	Endpoint Route	Endpoint Functionality
POST	/api/v2/auth/login	Login a user
POST	/api/v2/auth/signup	Signup a user
POST	/api/v2/incidents	Create a new incident
GET	/api/v2/incidents	Get all incidents
GET	/api/v2/incidents/admin	Admin get all incidents
PUT	/api/v2/incidents/admin/incident_id	Edit incident status
PUT	/api/v2/incidents/incident_id	Edit an incident
DELETE	/api/v2/incidents/incident_id	Delete a specific incident
GET	/api/v2/incidents/incident_id	Get a specific incident

Prerequisites

- pip
- virtualenv
- python 3 or python 2.7

Installation

Clone the repo

git clone https://github.com/izo30/iReporter.git

Create a virtual environment

virtualenv <environment name>

Activate the environment

$source <your environment name>/bin/activate

Install dependencies

$pip install -r requirements.txt

Run the app

python run.py

Running the tests

The tests have been written using the python module unittests. The path to tests folder is app/tests/v2 for version 1 tests only. Use a test framework like pytest to run the tests. Use the command:

pytest app/tests/v2

Deployment

The api is deployed on heroku on THIS link

Built with

Flask, a python framework

Authors

Isaac Wangethi