An app that enables citizens vote for different government offices transparently
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Have a text editor (vs-code, atom or sublime text) and
- Have Postman running on your local
- Set up postgres on your local with db name as
politico
- Assign the following to created db in the environment file
PASSWORD
USER
DB_PORT
DATABASE
HOST=localhost
After cloning, cd into it and on your command line run npm install to automatically install all the dependencies in the package.json file.
e.g
user~
$ cd politico
user~/politico
$ npm install
Use npm start to start the app
e.g
user~/politico
$ npm start
| S/N | HTTP VERBS | API ENDPOINTS | CORRESPONDING EFFECTS |
|---|---|---|---|
| 1 | POST | /api/v1/auth/signup | Signs up a user |
| 2 | POST | /api/v1/auth/login | Signs in a user |
| 3 | POST | /api/v1/parties | Creates parties |
| 4 | POST | /api/v1/offices | Creates an office |
| 5 | GET | /api/v1/parties | Gets all parties |
| 6 | GET | /api/v1/offices | Gets all offices |
| 7 | GET | /api/v1/parties/:id | Gets one party |
| 8 | GET | /api/v1/offices/:id | Gets one office |
| 9 | PATCH | /api/v1/parties/:id/name | Edits the party name |
| 10 | DELETE | /api/v1/parties/:id | Deletes a party |
| 11 | POST | /api/v1/offices/:id/register | Registers a user as a candidate |
| 12 | POST | /api/v1/votes | Creates a vote |
| 13 | GET | /api/v1/office/:id/result | Gets the result for a particular office |
- Javascript | NodeJs - The web framework used
- Node Package Manager - Dependency Management
- Mocha - Testing framework
Git-Hub
(https://www.pivotaltracker.com/n/projects/2238819)
- Chiazokam Echeta - Initial work
- My ever supportive team during the project build up