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.
Stars
1
Ecosystems:
Python
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.
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
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 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.
Contribute
- Join me here 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
Badges
Extracted from project README
