Giter Club home page Giter Club logo

politico's Introduction

Politico

A simple Node.js API that allows consumers (citizens) vote for politicians running for different government offices. Up to date version of project can be found on the develop branch.

Build Status Coverage Status codecov

Core Technologies

  1. NodeJS/Express
  2. Postgres/Sequelize ORM
  3. Mocha & Chai

To get started

  1. Clone the repository: git clone https://github.com/mazma1/politico
  2. Ensure you have installed NodeJS and Postgres
  3. Navigate into the app's root directory: cd politico
  4. Create a .env file in the root directory using the sample .env.sample file and update the credentials as specified.
  5. Install all dependencies: npm install
  6. Run tests to ensure the app is not broken: npm test
  7. Run npm run db:migrate to populate your database with initial user data
  8. Start the app: npm run start:dev

Endpoints

Access to endpoints are restricted based on the authorization token assigned to the user. This token is generated when a new user signs up, and when a returning user signs in.

For more of the api, go here.

politico's People

Contributors

mazma1 avatar

Watchers

James Cloos avatar  avatar

Forkers

abibou1

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.