iReporter seeks to provide a platform that allows users report corruption cases and interventions to designated authorities.
- Unregistered users can create an account
- Registered users can log into account
- Registered users can create red-flag (an incidence that's linked to corruption)/ intervention (a call to intervene)records
- Registered users can edit as well as delete either of their red-flag/ intervention records
- Registered users can add images/videos/geolocation to records
- Users can view red-flag/ intervention records of registered users
- Registered users can view all unresolved, resolved and rejected records
- An admin can change the status of any records
- An admin can view all records of all users
- Clone this repository here.
- Check to see you are in the develop branch, else run a
git checkout develop
in your terminal. - Run
npm install
to install all dependencies
npm run dev
to start the application.npm run test
to run test.- Connect to the API using Postman on port 3000.
HTTP Verbs | Endpoints | Action |
---|---|---|
GET | /api/v1/redflags | To get all redflags |
GET | /api/v1/interventions | To get all interventions |
GET | /api/v1/redflags/:id | To get specific redflags |
GET | /api/v1/interventions/:id | To get specific interventions |
POST | /api/v1/interventions/ | To post interventions |
POST | /api/v1/redflags/ | To post redflags |
PATCH | /api/v1/redflags/:id/location | To edit redflag locations |
PATCH | /api/v1/interventions/:id/location | To edit intervention locations |
PATCH | /api/v1/interventions/:id/comments | To edit intervention comments |
PATCH | /api/v1/redflags/:id/comments | To edit redflags comments |
DELETE | /api/v1/redflags/:id | To delete specific redflag |
DELETE | /api/v1/interventions/:id | To delete specific interventions |
This project is available for use under the MIT License.