lizfonseca / restaurapp Goto Github PK

#RESTaurApp

#####A management application for restaurant owners

##Structure

####General

The application will initially feature a list of restaurants owned by the user. When navigating a restaurant, menu items with their corresponding information will be displayed.

####Technical

This illustration below shows how the database holds the application's information:

• The restaurants table only holds the general information of each restaurant: a unique id key, the name, the corresponding location, the cuisine type, and an image.

• The items table holds more specific information of each restaurant (menu items) - each menu item will contain the following: a unique id key, the key for its corresponding restaurant, item name, its price, the order count (number of times the item has been ordered), and an image.

######The relationship between both tables is the following: restaurants table is the parent of the items table.

##User Stories

The application can be accessed via IP address and port:

IP: localhost

Port: 3000

The user can view the list of owned restaurants. The user can create new restaurants. The user can edit new restaurant information. The user can delete a selected restaurant.

#####Restaurants page

##Tools & Resources

• Bower
• Director
• JQuery
• Semantic UI

##Download

If you would like to try the application, go to:

https://github.com/lizfonseca/RESTaurApp

• Click on the 'Download as zip' button located on the right margin.

• Unzip files

• Open the Terminal and locate file

• Run json-server

$ json-server db.json

• Open browser window and type the following:

localhost:3000