Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neelxie/ireport-api
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 needs government intervention.
https://github.com/neelxie/ireport-api
Last synced: about 1 month ago
JSON representation
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 needs government intervention.
- Host: GitHub
- URL: https://github.com/neelxie/ireport-api
- Owner: neelxie
- Created: 2018-11-20T14:54:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T00:48:09.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T09:24:35.544Z (3 months ago)
- Language: Python
- Size: 176 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ireport-api
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.
[](https://travis-ci.org/neelxie/ireport-api)
[](https://www.codacy.com/app/neelxie/ireport-api?utm_source=github.com&utm_medium=referral&utm_content=neelxie/ireport-api&utm_campaign=Badge_Grade)
[](https://coveralls.io/github/neelxie/ireport-api?branch=develop)
[](https://codeclimate.com/github/neelxie/ireport-api/maintainability)
Site has been built with.
* Language - Python
* Serverside Framework - Flask
* Testing Framework - Pytest
* Linting Framework - Pylint
* Style GuideLine - Autopep8
## Application Demo
* Check out the [User Interface](https://neelxie.github.io/iReport/UI/)
## Features
| REQUESTS | APP ROUTES | FUNCTION | ROLE
|----------|------------|----------|-----
| GET | /api/v1/ | Default/Home Page. | All
| GET | /api/v1/red-flags | Fetch all red-flags records. | User
| GET | /api/v1/auth/users | Get all app users. | Admin
| GET | /api/v1/auth/users/[user_id] | Get a single user details | Admin
| GET | /api/v1/red-flags/[red_flag_id] | Fetch a specific red-flag by id. | User
| GET | /api/v1/auth/users/[user_id]/red-flags | Fetch a specific red-flag by id. | User
| PATCH | /api/v1/red-flags/[red_flag_id]/location | Edit/Change location of red-flag. | User
| PATCH | /api/v1/red-flags/[red_flag_id]/comment | Edit/Change comment of red-flag. | User
| PATCH | /api/v1/red-flags/[red_flag_id]/status | Change status of red-flag. | Admin
| DELETE | /api/v1/red-flags/[red_flag_id] | Delete red-flag. | User
| POST | /api/v1/red-flags | Create a red-flag record. | User
| POST | /api/v1/auth/signup | Register for an account as a user. | All
| POST | /api/v1/auth/login | Log into app account. | All
## Installation:
* Clone [this](https://github.com/neelxie/ireport-api.git) git repo to local directory.
``` cd ireport-api ```
* Create a virtual environment:
``` virtualenv venv ```
* Activate virtual environment:
``` venv\Scripts\activate ```
* Install dependencies:
``` pip install -r requirements.txt ```
* Do not forget to run this in the develop branch:
``` git checkout develop ```
## Running the application:
Inside the iReport-api folder.
``` python run.py ```
## Running the tests:
* Run this command in the project directory.
``` pytest --cov=.```
## Deployment
* This app has been deployed on Heroku at the url [here.](https://ireporta.herokuapp.com/api/v1/)
## Contribute
* Join me [here](https://github.com/neelxie/ireport-api/tree/develop) and let us create super amazing stuff together.
## Credits
* I thank GOD, to whom everything plays out ALWAYS.
* I thank all LevelUp 35 team, facilitators and attendees
for the help offered to better me.
* I would like to thank Andela for the opportunity to change the world.
## Author
* Sekidde Derrick