Skip to content

Latest commit

 

History

History
102 lines (58 loc) · 4.08 KB

README.md

File metadata and controls

102 lines (58 loc) · 4.08 KB

OVERVIEW

iLobby is a tool to explore, select and take action towards state-level legislators in the United States.

The frontend visualizes legislative districts using the Google Maps Javascript API.

The backend is an API that pulls data from the openstates.org API and can be found here: https://github.com/jasmosez/ilobby-backend

You will need your own API keys for both.

This project was bootstrapped with Create React App. See more information about that at the end of this readme.

React / Redux versions

Uses React 12.6 and Redux 7.2

Configuration

create an .env file in the root directory defining the following:

  • REACT_APP_GOOGLEMAPS_API_KEY is your Google Maps API key
  • REACT_APP_ILOBBY_API is the base URL of your backend server. If you are working from a local development environment is should be http://localhost:3000

How to run the test suite

There is not test coverage at this time

Current Deployment(s)

The frontend is currently deployed at https://ilobby.thisjames.com The backend is currently deployed at https://ilobby-backend.herokuapp.com

Let me know what you think!

Feel free to browse the iLobby project Trello board as well

//

CREATE REACT APP

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

yarm 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.

yarn test

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

yarn 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.

yarn 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.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify