POLITICO

POLITICO is a fullstack javascript application that enables citizens give their mandate to politicians running for different government offices while building trust in the process through transparency.

Table Of Content

1. Getting Started ..prerequisites ..Installation
2. Technology Stack ..* Dependencies
3. Features
4. Built With
5. Deployment
6. Useful Links
7. Acknowledgment

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To get started with this project you need a basic knowledge of :

Javascript (ES6)
NodeJs
SQL (Postgres)
Version Control (Git)

Installation

The follwing instructions will install the project on your local machine

1. Install [**Node JS**](https://nodejs.org/en/).
2. Install [**Postgres**](https://www.postgresql.org/) .
3. Clone the [**repository here**](https://github.com/PascalUlor/politico-app.git)
4. [**cd**] into the root directory of the project folder ```politico-app```.
5. Run `npm install` on the terminal to install Dependecies and Dev-Dependecies

How to run

1. open terminal and run npm run start:dev
2. open POSTMAN and type paste each of the following route:

_POST_ https://the-politico.herokuapp.com/api/v1/auth/signup

_POST_ https://the-politico.herokuapp.com/api/v1/auth/login

_POST_ https://the-politico.herokuapp.com/api/v1/parties

_GET_ https://the-politico.herokuapp.com/api/v1/parties

_GET_ https://the-politico.herokuapp.com/api/v1/parties/:id

_DELETE_ https://the-politico.herokuapp.com/api/v1/parties/:id

_PATCH_ https://the-politico.herokuapp.com/api/v1/parties/:id/name

_GET_ https://the-politico.herokuapp.com/api/v1/offices

_POST_ https://the-politico.herokuapp.com/api/v1/offices

_GET_ https://the-politico.herokuapp.com/api/v1/parties/:id

_GET_ https://the-politico.herokuapp.com/api/v1/office/:id/result

_POST_ https://the-politico.herokuapp.com/api/v1/office/:id/register

_POST_ https://the-politico.herokuapp.com/api/v1/vote

_PUT_ https://the-politico.herokuapp.com/api/v1/admin/:id/true

Technology Stack

UI & Templates

1. HTML & CSS
2. Javascript

Server Side

1. NodeJS
2. Express

Client Side

1. Javascript
2. HTML and CSS

Dependencies

• Postgres
• Nodejs

Features

The user interface is built for easy navigation and use of the application. It includes the following:

1. The users should be able to vote.
2. Users can create an account and log in.
3. The users should be able to register as candidate.
4. The admin should be able to view all users
5. The user can view election result

Authentication

• It uses JSON Web Token (JWT) for authentication.
• Token is generated on user login
• Token is perpetually verified to check the state of the user if logged in or not.
• Admin User will be pre-seeded into the application with administrative priviledges

Deployment

This Application will be deployed on Heroku Deploy

Useful Links

1. Project Management road map Pivotal Tracker
2. Github Repo
3. UI templatesGH-PAGES
4. Live demo on Heroku Deploy

Acknowledgment

• Andela
• Stackoverflow
• Codepen.io
• Hacker rank
• Travis Media