Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 2.77 KB

README.md

File metadata and controls

48 lines (34 loc) · 2.77 KB

Neighborhood Map React

A single-page web application, built using the Reactjs. It displays a Google Map of Hyderabad area, marking the famous Shopping Malls. Users can search shopping malls and, when selected, additional information about the mall is presented from the FourSquare APIs.

Github Pages: The App is Live Here

Features

  1. Type into the search box to filter the items in the list and the markers on the map simultaneously.
  2. When a user clicks the item in the sidebar, it triggers the corresponding information box with a little bounce of marker on the map. Also, the Focus traps inside the Information Box. On Close, the focus returns to the sidebar menu.
  3. Hamburger icon helps in hiding or displaying the sidebar. But below the screen width 992px, the sidebar closes automatically when an item is clicked to ensure better visibility on smaller devices.
  4. The first tab brings the focus on Hamburger icon, which will continue to the sidebar search and items. The focus will be trapped to Sidebar until closed.sssssss
  5. ESC key closes the Sidebar.
  6. Clicking any marker will be displaying the information box related to that place with a trapped focus.
  7. Offline First Implementation. The app is fully Offline accessible using Service Worker. Service Worker Implementation only works in Production Mode
  8. Accessibility (a11y) targeted code.

How to run the project in Development Mode

  • make sure the node and git is installed on your system.
  • clone the repo git clone https://github.com/onejeet/react-neighbourhood-map.git
  • get inside the directory cd react-neighbourhood-map
  • install all the dependencies npm install
  • Launch the app in Development Mode npm start

A new browser window open automatically in your browser displaying the app. If it doesn't, navigate to http://localhost:3000/ in your browser

NOTE: The service workers installs and caches the app only when it is in production mode. Checkout Live version Here

How to run the project in Production Mode

  1. Build the production-ready optimized code. npm run build
  2. Install the NPM's static server globally npm install -g serve. Ignore if already installed
  3. Launch the Production version of app serve -s build
  4. Open a new tab in your browser and navigate to the url http://localhost:5000/ to launch the app in production mode.

Guidelines

This Project followed the Rubric provided by the udacity. Udacity Project Rubric

Resources

  • Create-React-App Module from Facebook
  • NPM Modules
  • Udacity Frontend Nano-degree Course Material
  • Google Maps APIs
  • FourSquare Venues APIs