Skip to content

๐Ÿฅ‡ Udacity front-end nanodegree neighborhood map project

License

Notifications You must be signed in to change notification settings

MajhiRockzZ/neighborhood-map

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Neighborhood Map (React)

Neighborhood Map is a single page application featuring a map of my neighborhood where i would like to visit. The map including highlighted locations, third-party data about those locations and various ways to browse the content.

โšก๏ธ Installation

Use the package manager npm or yarn to install MyReads.

In the project directory, you can run:

$ npm install
$ yarn start || npm start

Open http://localhost:3000 to view it in the browser.

๐ŸŽฏ Usage

  • You will need a Google Maps Platform API key along with a Foursquare Client ID and a Foursquare Client Secret to use in the application:
    • If you do not have a Google Maps API key already, then you can obtain a Google Maps Platform API key for free here. You will have to create a billing account but there is a built in credit.
    • If you do not have the Foursquare Client ID or Foursquare Client Secret, then you can obtain them here by first creating a free account.
    • After you have all three data items, go to new folder in the src directory called api.
    • Within api, there will be a Javascript file called APIkey.js. Within this file add the following lines, where YOUR_GOOGLE_KEY, YOUR_FOURSQUARE_CLIENT_ID, and YOUR_FOURSQUARE_CLIENT_SECRET are replaced by your personalized data values (don't forget the delimiting quotes):
    export const GOOGLE_MAP_API_KEY = 'YOUR_GOOGLE_KEY'
    export const FOURSQUARE_CLIENT_ID = 'YOUR_FOURSQUARE_CLIENT_ID'
    export const FOURSQUARE_CLIENT_SECRET = 'YOUR_FOURSQUARE_CLIENT_SECRET'
    
    • Save the file.

๐Ÿ›  Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

๐Ÿ”‘ License

MIT

๐Ÿ† Credits

Sumesh Majhi

๐Ÿ’ Acknowledgments

Special thanks to Udacity and Google Scholarships team.