/elections-app

Sample web client for the Michigan Elections API.

Primary LanguageSCSS

elections-app

Elections-app is a React Single Page App (SPA)

Build Status

Goals

  1. Determine if an end user is Registered to Vote
  2. If Registered, show what a Ballot will contain
  3. If not Registered, link to the Michigan Voter Registration Information

Decisions

  1. React to Manage Javascript and HTML Components
  2. SCSS to give CSS a boost
  3. BEM to help organize the CSS
  4. Riteway for Testing

Prerequisites

  1. Install git Link to Install git instructions
  2. Install Node Link to Install Node instructions
  3. If planning to contribute you will need to be added to the project

Install Dependencies

$ npm install

For Development

$ npm run watch # This will do build every time you make a change

Build Project

$ npm run build-dev # This will build a non-minified version of the project
$ npm run build # This will build a minified version of the project

View Local

After running one of the builds you will have a dist folder.

  1. Navigate to that folder
  2. Open index.html with your web browser

Run Tests

$ npm run test # Run the tests once
$ npm run watch-test # Run the tests every time you make a change