Skip to content

Latest commit

 

History

History
executable file
·
109 lines (69 loc) · 4.19 KB

README.md

File metadata and controls

executable file
·
109 lines (69 loc) · 4.19 KB

StayInformed

The StayInformed web application gives United States based users the ability to look up their congressional representatives, find all the ways to get in touch with them and see who the biggest donors are. The app wants to bring a lot of publicly available information to one place.

Home Page:

screenshot

Search for you representatives:

screenshot

Register:

screenshot

Your dashboard:

screenshot

Your representatives info:

screenshot

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. This client runs locally in conjunction with the stay-informed-api (server), which can be found here. Please pay specific attention to the required environment variables and API access credentials detailed within the stay-informed-api README.

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm install

Installs necessary dependencies.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Prerequisites

Node Package Manager (npm) Node.js (back-end) PostgreSQL (back-end)

Built With

Authors

  • Michael Bravo
  • Michael Dusaniwskyj
  • Dustin Haefele
  • Lucas Vocos
  • Robert Wiggins

See also the list of external API dependencies which made this project possible.

Acknowledgments