Project Name

Pithy project description

Team

• Product Owner: Jacob Granberry
• Scrum Master: Hailey Bobella
• Development Team Members: Shannon Pearson, Sean Quillen

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Some usage instructions

Requirements

Put the following in a config.js file located at the root of the app (unless you want to change the reference): module.exports = { SESSION_PASSWORD: 'CaliforniaKnowsHowToParty', <!-- change...or don't... --> GOOGLE_API_KEY: '', <!-- get your key at https://developers.google.com/civic-information/docs/using_api --> PROPUBLICA_API_KEY: '' <!-- THIS IS CURRENTLY UNUSED - get your key at https://projects.propublica.org/api-docs/congress-api/ --> }

Development

Installing Dependencies

npm install -g webpack

npm install

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.

To start the app

mysql -u root < server/schema.sql to instantiate database (assumes you already have mySQL set up)

npm run react-dev to run webpack

npm run server-dev to start server