Code Monkey home page Code Monkey logo

politico's Introduction

Build Status

Coverage Status

Maintainability

Politico

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

User Interface (UI)

  • HTML
  • CSS

GitHub Pages link for UI

Politico/UI link

Link to Politico on Heroku

Politico/Heroku link


SERVER

API ENDPOINTS

Ressource URL Methods Description
/api/v1/auth/signup POST Get the user to signup
/api/v1/auth/signin POST Get the user to signin
/api/v1/parties POST Get the admin to post a political party
/api/v1/parties/ GET Get the admin to get all political parties
/api/v1/parties/:partyId GET Get the admin to view a specific political party by Id
/api/v1/parties/:partyId DELETE Get the admin to DELETE a specific political party by Id
/api/v1/offices/ POST Get the admin to post a new political office
/api/v1/offices/:officeId/register POST Get the admin to register a new candidate
/api/v1/offices/ GET Get the admin to get all political offices
/api/v1/offices/:officeId GET Get the admin to get a specific political office by Id
/api/v1/offices/:officeId DELETE Get the admin to DELETE a specific political by Id

For more details about endpoints check the documentation here

SERVER ENVIRONMENT

  • NODEJS (runtime environment for running JS codes)

FRAMEWORKS

  • Express (used for building fast APIs )

BUILT WITH

  • Javascript
  • NodeJs
  • ExpressJs

DATABASE

  • Postgresql

TESTING FRAMEWORK AND ASSERTION LIBRARY

  • Mocha
  • Chai

CONTINUOUS INTEGRATION

  • Travis CI

TEST COVERAGE

  • nyc

DEPLOYMENT

  • heroku

HOW TO RUN THE APPLICATION

SETTING UP THE ENVIRONMENT

  1. Clone this repository to your local PC

    https://github.com/DeliceLydia/Politico.git here

Installing

The installation of this application is fairly straightforward, After cloning this repository to your local machine,CD into the package folder using your terminal and run the following

  npm install

It will install the node_modules which will help you run the project on your local machine.

Run the server

  npm start

Create table in the database

  npm run tables

Delete table in the database

 npm run drop

Run test

 npm test

Author

Delice Lydia [email protected]

Licence & copyright

Copyright (c) Delice Lydia Ingabire, Software Developer

politico's People

Contributors

delicelydia avatar alainburindi avatar

Watchers

James Cloos avatar  avatar

Forkers

maknunaa

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.