Skip to content

Cedric-F/Medieval-France

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This project was bootstrapped with Create React App.

Medieval France - Neighborhood Map (React)

A React Application using the Google Maps API to showcase some of the French legacy.

Getting started

Installation

Cloning the development branch

git clone https://github.com/Cedric-F/Medieval-France.git

or

git clone --single-branch -b master https://github.com/Cedric-F/Medieval-France.git

Dependencies and local use

  • npm install to install the dependencies.
  • npm start to start a server and test the development build on localhost:3000.

Production build

Using this Live Page is recommended.

Structure

├── CONTRIBUTING.md
├── README.md - This file.
├── package.json
├── public/
│   ├── splash.png
│   ├── icon.png
│   ├── favicon.png
│   ├── favicon.ico
│   ├── manifest.json
│   └── index.html
└── src/
    ├── Components/
    │   ├── Filter.js
    │   ├── List.js
    │   ├── Map.js
    │   ├── Marker.js
    │   └── Fact.js
    ├── Fonts/
    │   └── Cardinal.woff
    ├── Icons/
    │   ├── Cities/
    │   │   └── 9 hand-selected logos
    │   ├── City.webp
    │   ├── Cathedral.webp
    │   └── Castle.webp
    ├── Images/
    │   ├── Photos/
    │   │   └── 39 hand-selected photos
    │   ├── Side.web
    │   └── Map-Border.png
    ├── map-style.json
    ├── locations.json
    ├── registerServiceWorker.js
    ├── App.css
    ├── App.test.js
    ├── App.js
    ├── index.css
    └── index.js

Application features

Name Description
Accessibility Aria labels and a fully managed focus make the navigation easier and Screen Readers-friendly.
Responsive Design The application fits perfectly on basically all the common device screens and remains easy to use on small viewports.
Offline mode Thanks to the Service Worker, the visited sections are gradually cached and stay available even with zero connectivity.
Custom map The Google Map uses a home-made paper-like style to perfectly fit in the application theme.
Hand-selected photos To ensure a perfect match, the 39 places photos have been handly selected and saved for the Web.
Trust-Worthy source The places history text is provided by the Wikipedia API.

Using the application

The application is really easy to use. It shows a plethora of places in France, and the respective list-view on the side. Using the filter at the top will gradually display only the places that match your query. Simply click on the marker or the corresponding list item to open the modal that will showcase the place data.

When available, the data is fetched directly in the browser cache to prevent from sending a new request everytime for data that has already been visited, and to provide an offline-experience.

License

None.

Dependencies

The following dependencies have been used to build this project. Make sure to run npm install before launching the development build.

Credits

  • The map legend icons are the property of Bethesda.
  • Most of the photos are from Wikipedia. If not, the source is mentionned right under it in the modal.

Contributing

This is a Student Project for the Udacity Front End Nanodegree. As such, pull requests will most likely be ignored.

Compatibility

Tested on:

  • Chrome
  • Chrome Canary
  • FireFox (65+)
  • FireFox Dev Edition

About

Deployment of the React Neighborhood Project for Udacity FEND

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors