Skip to content

krempin/frontend-nanodegree-neighborhood-map

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kyoto Temple Map

Screenshot

Screenshot

This is the final project for the Udacity Front End Nanodegree: The react-based app provides a map showing popular temples in Kyoto. The purpose of this project is to demonstrate understanding of

  • responsive, accessible HTML and CSS
  • handling and passing data from API
  • React, Javascript and JSX

How to install this app

This app requires Node.js to run. If node is installed, download the repository zip and save it to a directory or just use the command line to drive to this directory and clone the repository, install npm and start the development server:

$ git clone https://github.com/krempin/frontend-nanodegree-temple-map
$ npm install
$ npm start

Once started, a browser window will open and the app should be displayed. You can also navigate to http://localhost:3000

How to use this app

The app displays popular temples in Kyoto in a map and on a list on the left side. You can either click on a marker or on the temple name in the list to open information about the temple or shrine. You can also filter temples via the search input field.

Usage of Service Worker

The service worker is only available when the app is in its production mode. You can create a minified bundle with

$ npm run build

For more informations, visit Create React App on github.

Requirements for this project

General

  • Use React
  • Google Maps is integrated asynchroniously
  • The app can be used on all devices and the styling is responsive
  • Data requests that fail are handled gracefully using common fallback techniques (i.e. AJAX error or fail methods). 'Gracefully' means the user isn’t left wondering why a component isn’t working. If an API doesn’t load there should be some visible indication on the page that it didn’t load.

Documentation

  • A README file is included detailing all steps required to successfully run the application.
  • Comments are present and effectively explain longer code procedures.
  • Provide attribution for the source of additional data. For example, if using Foursquare, indicate somewhere in your UI and in your README that you are using Foursquare data.

Map functionality

  • The map contains at least 5 location markers
  • The sidebar contains a list of these 5 locations
  • The sidebar contains an input that filters locations by search input
  • If a search will be performed, the markers on the map will also be filtered
  • If you click on a marker on the map, an info window will appear
  • The info window contains additional data from a third party service integrated via API
  • The current clicked marker / temple on the list will be marked by color or animation
  • If you click on a temple link on the list, the marker will be active, animated and an info window will open

Accessibility

  • All content-related images include appropriate alternate text that clearly describes the content of the image.
  • Elements on the page use the appropriate semantic elements. For those elements in which a semantic element is not available, appropriate ARIA roles are defined.
  • Focus is appropriately managed allowing users to noticeably tab through each of the important elements of the page. Modal or interstitial windows appropriately lock focus.

Resources

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published