codeforhuntsville / Frontier

A civic app for finding whats near me
http://codeforhuntsville.com/
MIT License
9 stars 7 forks source link

Stories in Ready

Frontier

Frontier is an app that lets you give it your location and then returns a list of accessible resources nearby. For example, it might tell you the nearest open restaurants, the nearest open gas stations, the nearest public wifi hotspots, the nearest public restrooms, or the nearest open towing/mechanic shops.

Tech

This project is built using node.js. It uses the express web application framework on the backend to serve the website and provide APIs for the website to access data. The frontend is built using React & Bootstrap. The frontend assets are compiled using the Webpack module bundler and Babel compiler to allow the use of JSX and next generation Javascript features.

Setup

  1. install node.js on your computer
  2. setup git on your computer
  3. clone this repository: git clone https://github.com/codeforhuntsville/Frontier.git
  4. npm install in the cloned directory to install the required packages
  5. obtain a Google Places API Key (see instructions below)
  6. copy the file config/default.js to config/local.js, then fill in the googlePlacesApiKey property value with your key
  7. npm start to run the server

Google Places API Key

We use the Google Places API as a source for some of the data in Frontier. In order to make requests to the API, you must obtain an API key and configure Frontier to use it.

  1. Navigate to the Google Developers Console
  2. Create a new project, (e.g. "Frontier")
  3. Select APIs on the left
  4. Click "Google Places API Web Service" under the "Google Maps APIs" section
  5. Enable the API
  6. Go to "Credentials" on the left
  7. Create a new "Public API Access" "Server" key. Don't worry about IP restrictions for now
  8. Plug this key into the config in Frontier.

Join our community

License

MIT