Git Product home page Git Product logo

politico's Introduction

Badges

Build Status Coverage Status Code Climate

Politico

Politico is a platform which both the politicians and citizens can use. It enables citizens give their mandate to politicians running for different government offices while building trust in the process through transparency. A user can register and log in to the platform, view parties and the various political offices that have been created by the administrator.

Getting started

  1. Clone this repository
https://github.com/exdus/Politico
  1. Navigate to the cloned repository

Pre-requisites

  1. Python3
  2. Flask
  3. Postman

Installation

  1. Create a virtual environment
    virtualenv -p python3 venv
  1. Activate the virtual environment
    source venv/bin/activate
  1. Switch to 'develop' branch
    git checkout develop
  1. Install requirements
    pip install -r requirements.txt
  1. Run the application

    python3 run.py
  1. Test the application

    python3 -m pytest

Test the following api endpoints using postman

Endpoint Functionality
/api/v1/party POST Create a party record
/api/v1/party/<party_id> GET Fetch a specific party record
/api/v1/party/<party_id> PATCH Edit a given party record
/api/v1/party/<party_id> DELETE delete a specific party record
/api/v1/parties GET Fetch all party records
/api/v1/office POST Create a political office
/api/v1/office/<office_id> GET get specific office details
/api/v1/ offices GET View all political offices
/api/v1/signup POST sign up for an account
/api/v1/signin GET sign in to the api

Contributors

  • Bunei Kelvin

Acknowledgements

  • #nbo-37
  • Andela community

politico's People

Contributors

arapbunei avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.