/politico-1

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

Primary LanguageJavaScript

Politico

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

commit activities last commit repo size

Maintainability Build Status Coverage Status Test Coverage

Technologies

  • Nodejs(ES6)
  • Git
  • NPM
  • Express
  • PostgreSQL

Linting Library

  • Eslint (AirBnB)

Installation

Clone the repo politico.

git clone https://github.com/emmsdan/politico.git

You can Use the package manager npm to Install dependencies.

npm install

Usage

run server

npm start

Test

Mocha is the testing framework together with chai assertion library

run test

npm run test

Application Endpoints

HTTP Request End Point Functionality
POST /auth/signup Create a user account.
POST /auth/login Login a user.
POST /auth/reset Reset user password.
POST /office//register Register a user as a candidate running for a political office.
POST /votes/ Vote for a candidate.
POST /office//result Collate and fetch the result of specific office following a concluded election.
POST /petitions/ Create petitions challenging the outcome of a concluded election.
POST /votes/ Vote for a candidate.
POST /parties/ Create a political party.
GET /parties/ Fetch all political party
GET /parties/ Fetch specific political party
PATCH /parties//name Edit the name of a specific political party.
DELETE /parties/ Delete a specific political party.
POST /offices/ Create a political office.
GET /offices/ Fetch all political office records
GET /offices/ Fetch all specific political office
- - -

Acknowledgement

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Author

Emmanuel Daniel

You can follow me on follow me on twitter