Giter Site home page Giter Site logo

restaurant-reviews-app's Introduction

Restaurant Reviews App

The Restaurant Reviews App is a project for the Udacity Front End nanodegree.

Tabel of Contents

Objectives and Requirements

The object of the project is to refactor the site to more modern standards. Originally the site was designed for desktop only screens which scaled poorly to mobile screens. Using a combination of grid and flexbox, screens of various sizes should get a better experience. Accessibilty and PWA(Progressive Web Apps) features were implemented to the site. Service workers were registered to cache static assets and display when the site is offline. Performance is also increase as a result. The Ruberic provided by the FEND course was used to make sure it met all requirements. No UI frameworks were allowed in this project.

Technologies

This project was made with the following technologies:

  • HTML5
  • CSS
  • Javascript ES6
  • Yeoman Generator Webapp (npm, gulp, browserfiy)
  • Service Worker and Cache API

Source code found in /app, dev files are stored in /.temp and distro build is compiled and runs from /dist

Getting Started

To develop the app locally you must have node.js and git installed on your computer.

Clone or download the project and go to the project folder and install dependencies

cd restaurant-reviews-app
npm install

Once installed, you can now run npm start to build start the server and build the development files for the project. This will create a .tmp folder to be used by the webserver and viewable at http://localhost:9000

For production ready project with full compression on code and assets then use

npm run build

IMPORTANT NOTE Due to the way the gulp script builds the Dev and Production files differently, It is important you deregister service workers and delete caches when you switch between development and production builds.

Prerequisites

Browserify uses babel to transpile es6 code as backwards compatible as much as possible, the limitations can be found here.

Acknowledgments

  • This app is based on the the Udacity starter app found here

  • Leafletjs and Mapbox

  • Yeoman Generator Webapp build process scaffold using here

restaurant-reviews-app's People

Contributors

gallardocode avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.