Project Title

Restaurant-Reviews-Application

Table of contents

• Getting Started
• Prerequisites
• Up and Running
• Project Description
• Build In
• Frameworks used
• Features
• Inspiration
• Status
• Authors
• License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development purposes. Follow the Prerequisites need to run the code for furthur research.

Prerequisites

Softwares Needed

Download and Install VISUAL STUDIO CODE
https://code.visualstudio.com/download

Need Browser to run or debug our code

• Download and Install GOOGLE CHROME Browser

Need to run project from http server

• Download and Install Python
https://www.python.org/downloads/

Need chromevox tool to check web accessibility

• Add to GOOGLE CHROME Browser
https://chrome.google.com/webstore/detail/chromevox/kgejglhpjiefppelpmljglcjbhoiplfn

Knowledge

• Knowledge in HTML, CSS, JAVASCRIPT
• Knowledge in OOPS in Javascript.
• Knowledge in web Accessibility
• Knowledge in serviceworkers

Knowledge Base

• HTML TUTORIAL - https://www.w3schools.com/html/
• CSS TUTORIAL - https://css-tricks.com/
• JS TUTORIAL - https://developer.mozilla.org/bm/docs/Web/JavaScript
• WEB ACCESSIBILITY - https://developers.google.com/web/fundamentals/
• SERVICE WORKERS - https://developers.google.com/web/fundamentals/primers/service-workers/

Up and Running

View project Files

After Downloading Visual Studio Code --> Open Visual Studio Code software -> Open Folder option -> select Restaurant Review Application folder -> set up your workspace.

To run the project in browser

• Install Python
• Set current project directory in command prompt using command --> cd c:\project location
• Open command prompt --> check the version of python using command --> python -V
• For Python v2.x type command to start htttp server --> python -m SimpleHTTPServer 8000
• For Python v3.x type command to start htttp server --> python3 -m http.server 8000
• Windows by default v3.x type command to start htttp server --> python -m http.server 8000
• Open Google chrome --> navigate --> http://localhost:8000 --> run project.

Project Description

Restaurant Review App is a mobile-ready web application which provides accessibility features and responsiveness on different sized displays. It provides service worker to cache website data inorder to create offline experience for our users.

Build In

VS code Editor Visual Studio Code is a source code editor developed by Microsoft for Windows, Linux and macOS Restaurant Review App developed in Visual Studio code software.

Frameworks used

Leaflet.js

JavaScript library for interactive maps

URL : https://leafletjs.com/

MapBox API

Open source mapping platform for custom designed maps.

URL : https://www.mapbox.com/

Features

• List of features ready for future development
• Login facility for users
• Implement CRUD operations

Inspiration

Project inspiration from Udacity FrontEnd Developer Nanodegree Program.

Status

Project is in progress for new design and developement for advanced features.

Authors

Ranjith Kumar - [Restaurant Reviews App] - (https://github.com/webbizleads/Restaurant-Reviews-App)

License

This project is the open source license