ireporter

Simple web app that lets citizens report cases of corruption to the appropriate authorities. Users can also report on things that needs government intervention.

Required Features

Users can create an account
Users can log into their account
Users can make a red-flag or intervention record
Users can edit their red-flag or intervention record
Admin can change status of ared-flag or intervention record from under investigation, resolved or rejected.

Technologies

Node JS
Express
Mocha & Chai
ESLint
Babel
Travis CI
Code Climate
Coveralls

Requirements and Installation

Install Node Js and Git

Node Js
Git

To run:

$ git clone https://github.com/valenstical/ireporter.git
$ cd ireporter
$ npm install
$ npm start

Testing

$ npm test

Pivotal Tracker stories

View the pivotal tracker stories for this project here https://www.pivotaltracker.com/projects/2227161

Front-end Design

You can see a hosted version of the frontend at https://valenstical.github.io/ireporter/

API

The api endpoints are hosted on heroku. Visit https://ireporter-nigeria.herokuapp.com/ to make requests to endpoints.

API Endpoints

All API endpoint must use the api/v1 prefix.

Endpoint	Functionality
GET /red-flags	Get all red-flags reports
GET /red-flags/\	Get the details of a specific red-flag
PATCH /red-flags/\/location	Edit the location of a red-flag report
PATCH /red-flags/\/comment	Edit the comment of a red-flag report
DELETE /red-flags/\	Delete a red-flag
GET /interventions	Get all interventions reports
GET /interventions/\	Get the details of a specific intervention
PATCH /interventions/\/location	Edit the location of an intervention report
PATCH /interventions/\/comment	Edit the comment of an intervention report
DELETE /interventions/\	Delete an intervention
POST /interventions/	Creates a new intervention record
POST /red-flags/	Creates a new red-flag record
PATCH /interventions/\/status	Change the status of an intervention report
PATCH /red-flags/\/status	Change the status of a red-flag report

API Documentation

https://app.swaggerhub.com/apis/andela51/1-i_reporter/1.0

Author

Okosun Valentine Ejodamen

valenstical / ireporter

readme