Manorlds-Eaglespark/i_reporter_api

Corruption is a huge bane to Africa’s development. African countries must develop novel and localised solutions that will curb this menace, hence the birth of iReporter. 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 # iReporter API Corruption is a huge bane to Africa’s development. African countries must develop novel and localised solutions that will curb this menace, hence the birth of iReporter. 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. ## GETTING STARTED * Clone this repo using ```git clone github.com``` * Then change directory to the new folder ```cd ``` * Create a virtual environment ```virtualenv ``` * Activate the virtual environment ```. /bin/activate``` * Switch to the appropriate branch and follow along. ## REQUIREMENTS * Install all the dependencies in your virtual environment ```pip install requirements.txt``` ## PREREQUITES - A Working computer. Linnux, windows or Mac OS - Postman, to test endpoints - Git, to follow different repo branches smoothly. - Text Editor, preferably Visual Studio Code. ## TESTING * Install Pytest to run the unittests ```pip install pyteset``` * Run tests by entering pytest into your terimal. * To get your test coverage locally, use ```pytest --cov=.``` # Heroku API Endpoints | HTTP Method | End Point | Public Access | Action | | :------------:|:---------------:| :---------------:|:---------------------:| | POST | /api/v1/auth/register | TRUE | Create an account. | | POST | /api/v1/auth/login | TRUE | User login. | | GET | /api/v1/red-flags | TRUE | Fetch all red-flag records. | | GET | /api/v1/red-flags/ | TRUE | Fetch a specific red-flag record. | | POST | /api/v1/red-flags | TRUE | Create a red-flag record. | | PATCH | /api/v1/red-flags/ /location | TRUE | Edit the location of a specific red-flag record. | | PATCH | /api/v1/red-flags/ /comment | TRUE | Edit the comment of a specific red-flag record. | | DELETE | /api/v1/red-flags …