iReporter is a simple web application that enables any/every citizen to bring any form of corruption to the notice of appropriate authorities and the general public.
In this case, users can also report on things that needs government intervention.
- Challenge 1 Work Procedure
- Challenge 2 Work Process Guidelines
This project works on the URLs below for the operations of the HTTP resources
REQUEST | ROUTE | FUNCTIONALITY |
---|---|---|
GET | /api/v1/users |
Returns all saved records of users |
POST | /api/v1/users |
Creates a new user record |
GET | /api/v1/users/<user_id> |
Returns a specific user |
PUT | /api/v1/users/<user_id> |
Updates a specific user record |
GET | /api/v1/users/<user_id>/edit |
Returns a specific user for editing |
DELETE | /api/v1/users/<user_id> |
Deletes a specific user record |
REQUEST | ROUTE | FUNCTIONALITY |
---|---|---|
GET | /api/v1/red-flags |
_Returns all saved records of red-flags |
POST | /api/v1/red-flags |
Creates a new red-flag record |
GET | /api/v1/red-flags/<flag_id> |
Returns a specific red-flag |
PUT | /api/v1/red-flags/<flag_id> |
Updates a specific red-flag record |
GET | /api/v1/red-flags/<flag_id>/edit |
Returns a specific red-flag for editing |
DELETE | /api/v1/red-flags/<flag_id> |
Deletes a specific red-flag record |
REQUEST | ROUTE | FUNCTIONALITY |
---|---|---|
GET | /api/v1/interventions |
Returns all saved records of interventions |
POST | /api/v1/interventions |
Creates a new intervention record |
GET | /api/v1/interventions/<int_id> |
Returns a specific intervention |
PUT | /api/v1/interventions/<int_id> |
Updates a specific intervention record |
GET | /api/v1/interventions/<int_id>/edit |
Returns a specific intervention for editing |
DELETE | /api/v1/interventions/<int_id> |
Deletes a specific intervention record |
Heroku: This app is hosted at iReporter API web!
GitHub Pages: Find the user interface via iReporter UI web!
-
Get an empty folders where to place the project
Either download the project and extract it in the new empty folder or copy the link to clone it as
git clone https://github.com/BrunoNicholas/iReporter.git
2.Hopefully you installed python, create a virtual environment
e.g. venv
and activate it with the operating system you have.
i.e. #source venv/bin/activate
for linux, or #venv/Scripts/activate.bat
for windows
3.Install all required packages while inside the folder as below
pip3 install -r requirements.txt
4.Start the application as.
python run.py
5.User the routes above for checking the API and the UI for navigating through the user interface Thanks!
Developed By
Bruno Nicholas Sserunkuma, sbnibro256@gmail.com