README.md

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.

Complete Tasks

User stories on Pivotal tracker

🔗 Link to user stories

UI Templates

🔗 Live project on gh-pages

🔗 Link to Source code

API V1 - python data structures

🚀 Link to Deployment on Heroku API V1

📗 Link to API V1 documentation

🔗 Link API V1 source code

API V2 - PostgreSQL database

🚀 Link to Deployment on Heroku API V2

📗 Link to API V2 documentation

🔗 Link API V2 Source code

How to set up the project

Open the terminal and run the following commands

    git clone https://github.com/kalsmic/iReporterApi.git
    cd iReporterApi
    git checkout api-database
    python3 -m venv venv
    source venv/bin.activate
    pip3 install -r requirements.txt
    source venv/bin/activate
    export APP_SETTINGS="instance.config.ProductionConfig"
    export SECRET_KEY="your secret key"
    python deploy.py

How to run tests

Enter the command below in the terminal to run the tests with coverage using pytest

  pytest --cov

Built With

• Python - A programming language that lets you work quickly and integrate systems more effectively
• Flask - A microframework for Python based on Werkzeug, Jinja 2 and good intentions.

Author

Kalule Arthur

Acknowledgements

Big thanks to LFA's and fellow colleagues at Andela for reviewing the project and the guiding on the basic principles.