iReporter-Flask

An application that allows users to report incidences of corruption(Redflags) and to request for assistance on matters of public good(Interventions).

User

Click here to access API documentation

Prerequisites

What you need to get started:

• Python 3.6

• virtualenv

• Pip

• Flask

Technologies used

- Python 3.6.5
- Flask_RESTful
- PostgresQl

Usage:

$ git clone  https://github.com/lupamo3/iReporter-Flask.git

Change directory into the iReporter-Flask directory :

$ cd iReporter-Flask

Create and activate your virtual environment :

$ Virtual venv python=[Python-Version]
$ Pip install auto-env

Install project requirements :

pip install -r requirements.txt

Run the tests :

  - nosetests --with-coverage --cover-package=app
  - py.test -v --cov-report term-missing --cov app

Test the application on Postman

Test The API end-points

• Run iReporter on your postman to test the URLs

or use:

URL	METHOD	MESSAGE
api/v2/incidents/	GET	Get all Incidence records.
api/v2/incidents/	POST	Create a Incidence record.
api/v2/incidents/int:id	GETint:id	Get Incident by id
api/v2/incidents/int:id	DELETEint:id	Delete a specific incident record
api/v2/incidents/int:id/comment	PATCHint:id/comment	Patch a comment incident record
api/v2/incidents/int:id/location	PATCHint:id/location	Patch a location incident record
api/v2/incidents/int:id/status	PATCHint:id/status	Patch a status record.
api/v2/signup	POST	Create i-Reporter account.
api/v2/users	GET	Get all Users
api/v2/userss/int:id	GETint:id	Get a user by id

---

Help & Review

• Feel free to reach me via email and to fork this project
  • Any feedback would be appreciated.
  • The Pull requests have bit by bit application documentation

---

License

---

• Copyright 2018 © iReporter.