iReporter enables any/every citizen to bring any form of corruption to the notice of appropriate authorities and the general public. Users can also report on things that need government intervention around the community

1. Users can create an account and log in.
2. Users can create a ​ redflag ​ record (An incident linked to corruption)
3. Users can create ​ intervention​​ record​ ​ (a call for a government agency to intervene e.g repair bad road sections, collapsed bridges, flooding e.t.c).
4. Users can edit their ​ redflag ​ or ​ intervention ​ records.
5. Users can delete their ​ redflag ​ or ​ intervention ​ records.
6. Users can add geolocation (Lat Long Coordinates) to their ​ redflag ​ or ​ intervention records​ .
7. Users can change the geolocation (Lat Long Coordinates) attached to their ​ redflag ​ or intervention ​ records​ .
8. Admin can change the ​ status​​ of a record to either ​ under investigation, rejected ​ (in the event of a false claim)​ ​ or​ resolved ( ​ in the event that the claim has been investigated and resolved)​

API Documentation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

• A working computer with Windows OS, Linux OS, Mac OS.
• A text editor
• Postman to consume the API endpoints
• Git for Version control
• Python 3.6
• Pytest for testing the api

Open the directory you are going to work from and clone this project using this link

Open your terminal or console and navigate to your working directory then enter the following commands to create a virtual environment, install all the requirements, create a database, activate the database path and run the API respectively

$ mkvirtualenv venv
$ pip install -r requirements.txt
$ python run.py
$ sudo -u postgres psql
$ source .env
$ CREATE DATABASE ireporter;

The API is hosted on Heroku

• Install Pytest $ pip install pytest
• Navigate to project root
• Use pytest to run the tests
• To have a more detailed look at the tests use pytest -v

Prefix api/v2/ to all api endpoints below

• Python 3.6
• Flask (Python microframework)
• PostgreSQL

• Sublime Text
• VS Code
• Virtual environment
• Pylint
• Pytest
• PostgreSQL

This is version 1 of the API

James Mudidi

• Special Thanks to God Almighty
• Special Thanks to Andela
• Special Thanks to Andela KLA Bootcamp 15 members