https://github.com/ctrachte/neighborhood-map
A single-page application using React featuring a map of a neighborhood or a neighborhood I would like to visit.
https://github.com/ctrachte/neighborhood-map
Last synced: 24 days ago
JSON representation
A single-page application using React featuring a map of a neighborhood or a neighborhood I would like to visit.
- Host: GitHub
- URL: https://github.com/ctrachte/neighborhood-map
- Owner: ctrachte
- Created: 2018-11-14T18:29:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-20T18:06:53.000Z (over 7 years ago)
- Last Synced: 2025-03-06T03:14:19.869Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 435 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Neighborhood Map
A single-page web application, built with React, that displays a Google Map of Cabot Arkansas, and suggested places to visit. Users can filter suggested locations and when selected, additional information is presented from the FourSquare API.
*Note: the production version is linked below but may not display all information since the access tokens I provided may have hit their limit as a free user (Google API and FourSquare)*
Check out the live demo [here](https://ctrachte.github.io/Neighborhood-Map/)!
## Getting Started
To run this app for development:
* ensure you have Node.js and NPM installed globally first.
* in your terminal use the command `git clone https://github.com/ctrachte/Neighborhood-Map.git`
* in the directory you cloned to, install all project dependencies with `npm install`
* get your own API keys from [FourSquare](https://developer.foursquare.com/docs/api/configuration/authentication) and [Google Maps](https://developers.google.com/maps/documentation/javascript/get-api-key)
* replace the maps key in `public/index.html`, and the FourSquare key/secret in the App.js file at the top with your keys.
* start the development server with `npm start`
**NOTE:** *By default, service workers will only cache data when in production mode.*
## Deploying to production
This app uses the github pages NPM package to deploy to production
* edit the `homepage` property in `package.json` to match your github pages account and the repository name
* in the root directory run `npm run deploy`
## Create React App
This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). You can find more information on how to perform common tasks [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md).
## Contributing
This repository is not likely to be actively managed, so please be patient with pull requests!