tharunShiv / mws-restaurant-stage-1

MWS track main Project Challenge 1

Home Page:https://restaurantreviews.ml

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mobile Web Specialist Certification Course

About the Project

It is a Progressive Web App, which works with service-workers to produce websites that work offline too. They load faster, install on phone, desktop, and visually similar to hybrid apps.

Click here to Read about PWAs here - Their Advantages and Disadvantages

Live DEMO : ( NOT UPDATED FOR STAGE 2 )

https://restaurantreviews.ml/


Three Stage Course Material Project - Restaurant Reviews

Project Overview: Stage 1

For the Restaurant Reviews projects, you will incrementally convert a static webpage to a mobile-ready web application. In Stage One, you will take a static design that lacks accessibility and convert the design to be responsive on different sized displays and accessible for screen reader use. You will also add a service worker to begin the process of creating a seamless offline experience for your users.

Specification

You have been provided the code for a restaurant reviews website. The code has a lot of issues. It’s barely usable on a desktop browser, much less a mobile device. It also doesn’t include any standard accessibility features, and it doesn’t work offline at all. Your job is to update the code to resolve these issues while still maintaining the included functionality.

What do I do from here?

  1. In this folder, start up a simple HTTP server to serve up the site files on your local computer. Python has some simple tools to do this, and you don't even need to know Python. For most people, it's already installed on your computer.

In a terminal, check the version of Python you have: python -V. If you have Python 2.x, spin up the server with python -m SimpleHTTPServer 8000 (or some other port, if port 8000 is already in use.) For Python 3.x, you can use python3 -m http.server 8000. If you don't have Python installed, navigate to Python's website to download and install the software.

  1. With your server running, visit the site: http://localhost:8000, and look around for a bit to see what the current experience looks like.
  2. Explore the provided code, and start making a plan to implement the required features in three areas: responsive design, accessibility and offline use.
  3. Write code to implement the updates to get this site on its way to being a mobile-ready website.

Leaflet.js and Mapbox:

This repository uses leafletjs with Mapbox. You need to replace <your MAPBOX API KEY HERE> with a token from Mapbox. Mapbox is free to use, and does not require any payment information.

Note about ES6

Most of the code in this project has been written to the ES6 JavaScript specification for compatibility with modern web browsers and future proofing JavaScript code. As much as possible, try to maintain use of ES6 in any additional JavaScript you write.

Project Overview: Stage 2

Steps to get the project up and running

1. Run the development server : Download it from here: https://github.com/udacity/mws-restaurant-stage-2
2. Run the development server by using the command: 'node server' at mws-restaurant-stage-2 directory
3. Go to this project directory: Install Live Server
4. npm install -g live-server
5. Come to this project directory again and use the command 'live-server'
6. Open the url using Chrome.

Project Overview

For the Restaurant Reviews projects, you will incrementally convert a static webpage to a mobile-ready web application. In Stage Two, you will take the responsive, accessible design you built in Stage One and connect it to an external server. You’ll begin by using asynchronous JavaScript to request JSON data from the server. You’ll store data received from the server in an offline database using IndexedDB, which will create an app shell architecture. Finally, you’ll work to optimize your site to meet performance benchmarks, which you’ll test using Lighthouse.

Tested scenarios

Online

  1. index.html working
  2. restaurant.html working
  3. Lazy Loading of images working

Offline

  1. index.html working
  2. restaurant.html working ( the pages which were visited when online )
  3. The images which were loaded when online, because of lazy loading ( the tradeoff )

Project Overview: Stage 3

Steps to get the project up and running

1. Run the development server : Download it from here: https://github.com/udacity/mws-restaurant-stage-3
2. Run the development server by using the command: 'node server' at mws-restaurant-stage-3 directory
3. Go to this project directory: Install Live Server
4. npm install -g live-server
5. Come to this project directory again and use the command 'live-server'
6. Open the url using Chrome.

Project Overview

Add a form to allow users to submit their own reviews. Add functionality to defer submission of the form until connection is re-established.

Tested scenarios

Online

  1. index.html working
  2. restaurant.html working
  3. Lazy Loading of images working
  4. reviews.html working
  5. reviews are stored and retrieved perfectly
  6. Favourite feature implemented

Offline

  1. index.html working
  2. restaurant.html working ( the pages which were visited when online )
  3. The images which were loaded when online, because of lazy loading ( the tradeoff )
  4. reviews.html working and reviews are not accepted when offline
  5. No posting review offline

About

MWS track main Project Challenge 1

https://restaurantreviews.ml


Languages

Language:HTML 72.9%Language:JavaScript 27.1%