Skip to content

ratracegrad/mws-restaurant-stage-1

 
 

Repository files navigation

Restaurant Review

This website is a demonstration of best practices for building a responsive website that includes accessibility access. This website was created as a project for the Udacity Mobile Web Specialist Nanodegree which I am completing because I won a Google Scholarship.

Table of Contents

  1. [Live Demo](#live demo)
  2. [Getting Started](#getting started)
  3. Author
  4. Contributing
  5. [Style Guide](#style guide)
  6. License

Live Demo

I have a live demo of this website that you can view.


Website Overview

This website provides information on restaurants located in the New York, NY metro area. The main page of the website provides a google map that shows all the restaurant locations with a pin. Below the map is a list of all restaurants that I currently have in my database. Here is an example of what the home page of the website looks like:

Homepage

If you click on any restaurant, you will be taken to a detail page. The detail page will show the location of the restaurant on a map, their hours of operation, and any reviews that have been left for the restaurant. Here is what the details page looks like for a restaurant:

Detail Page

Also on the details page are any reviews that have been left for that restaurant. Here is what the reviews look like:

Reviews


Getting Started

Installing Dependencies

You will need to clone this repo with this command: git clone https://github.com/ratracegrad/mws-restaurant-stage-1.git

After cloning you will need to change into the directory holding the source code with the command: cd mws-restaurant-stage-1

From within the root directory you will need to install the dependencies with the command: npm install

Linting

I have included a script to lint the code to verify it passes standards. You can run this script with the command: npm run lint


Author


Contributing

See CONTRIBUTING.md for contribution guidelines.


Style Guide

If you are interested in contributing to this project please read my style guide first.


License

This project is licensed under the MIT License - see the LICENSE.md file for details