This repo serves as a home for the 'Restaurant Reviews App' project in the Udacity Frontend Web Development Nanodegree.
This project started as a webpage that was gradually converted to a responsive offline application. It uses a database helper (ie. dbhelper.js file) to populate data from the restaurants.json file. The main.js generates the HTML element for the index page, while the restaurant_info.js renders the restaurant reviews page. A service worker sw.js caches the app data for offline storage allowing users to interact with the app even when offine or with sporatic internet access.
✔️ This project uses the following dependencies:
- Python - read about configuring Python for your system
- Mapbox map API
- Leaflet.js an open source library for mobile-friendly maps
- a Service Worker for caching assets for offline use - Read about service workers
To setup on a local machine: 📝
- Fork, clone or download and unzip this repo.
- In the root of this project's directory launch a local server:
- Python 2:
python -m SimpleHTTPServer 8000 - Python 3:
python3 -m http.server 8000 - Windows 10
py -m http.server 8000
- Python 2:
- Visit the site in your web browser at http://localhost:8000
- Change the server port number by updating the
dbhelper.jsfile
See troubleshooting for advice on getting through a few scenarios after setup.
This repository uses the following style guides and repositories:
- Udacity's Project Grading Rubric and Style Guides for the Frontend Nanodegree
- Starter code from Udacity's Mobile Web Specialist project Restaurant Reviews Stage 1
- MDN Service Worker code snippet Using Service Workers
Reference Links:
- Debugging Service Workers in Firefox
- Managing Service Workers in different browsers
- A Brief Guide to Accessibility Tools in Firefox
- Aria Roles
- Deploying offline- first apps to Github Pages
For feedback feel free to open an issue on Github for this project. This project is build with love ❤️ coffee ☕ and an awesome playlist 🎵. Copyright © 2023-2025 @heycynwrites.