kellswork / politico Goto Github PK

View Code? Open in Web Editor NEW

Politico is an online voting platform that lets users vote for candidates running for different political offices. Politico enables citizens give their mandate to politicians running for different government offices.

License: MIT License

JavaScript 28.94% HTML 45.12% CSS 25.94% Procfile 0.01%

politico's Introduction

Politico

UI - Politico

Required Features

Users can create an account and login
Admin (electorial body) can create a political party
Admin (electorial body) can delete a political party
Admin (electorial body) can create different political offices
Users can vote for only one politican per political office
Users can see the results of election

Optional Features

User can reset password
A politican can create a petition against a concluded political office election

Getting Started

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

Installing

Install Node js
Clone the repository https://github.com/Kellswork/Politico.git
Navigate to the location of the folder
Run npm install to install dependencies
Run npm start to get the app started on your local machine

Running the tests

Server Side

To run tests for the server side

Navigate to the location of the folder in your terminal
Run npm run test to run app tests
Run npm run coverage to run test coverage with istanbul on the app

Built With

Client Side:

The frontend was implmented using:

HTML A standard markup language for creating websites
CSS This describes how HTML elements are to be displayed on screen
JAVASCRIPT A programing language of html and the web

Backend

The backend was implemented using:

Node Node Js is a Javascript runtime built on Chrome's V8 JavaScript engine
Express Express is a minimal and flexible Node.js web application framework
PostgreSQL POSTGRESQL: The world's most advanced open source relational database