Skip to content

Politico enables citizens give their mandate to politicians running for different government offices while building trust in the process through transparency.

Notifications You must be signed in to change notification settings

Fiyiin/politico

Repository files navigation

politico

Build Status Maintainability Test Coverage

Politico enables citizens give their mandate to politicians running for different government offices while building trust in the process through transparency.

Getting Started

Clone this repo to your local machine to get started. This project is a Node.js project, so you mush have Node.js and npm installed on your local machine.


Usage

After you clone this repo to your desktop, go to its root directory and run npm install to install its dependencies.

Once the dependencies are installed, you can run npm start to start the application. You will then be able to access it at localhost:3000


Prerequisites

You'll need the following packages to run the projecct

npm

Tech/framework used

  • Node js
  • Express
  • Mocha
  • Supertest
  • Chai
  • ES6

Features

  • Users can sign up
  • Users can login to their account
  • Admin can create political parties
  • Admin can delete a political parties
  • Admin can create different political offices
  • Users can vote for only one politcian per political office
  • Users can see the results of election

Api endpoints

- api/v1/auth/signup
- api/v1/auth/login
- api/v1/parties
- api/v1/parties/:id
- api/v1/parties/:id/name
- api/v1/offices
- api/v1/offices/:id
- api/v1/offices/<userId>/register
- api/v1/votes
- api/v1/offices/<office-id>/result

Author

Fiyin Kolawole

License

This project is licensed under the terms of the ISC license.

About

Politico enables citizens give their mandate to politicians running for different government offices while building trust in the process through transparency.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published