/CSCI3308_FinalProject_ShelfLife_Deliverables

This will hold the deliverables for our final project for CSCI 3308.

Primary LanguageJavaScript

CSCI3308_FinalProject_ShelfLife_Deliverables

ShelfLife is a website designed for a restraurant to track all its data in one place. Our website has five main features. Our inventory feature allows the user to view their stocked and low inventory items. This page displays each ingredient's name, the unit it is measured in, and the amount in stock. The order forms feature allows the user to re-order inventory. This page displays current inventory, and gives the user an option to re-order specific ingredints. The sales feature allows the user to view the restraunt's past sales. The user can view the sales for the current day, week, month or year. The send order feature allows the user to ring in a guests food order. When a dish is ordered, the inventory and sales information are updated. Lastly, the account feature allows the user to change their password or add a menu item. If a new ingredient is needed for an added menu item, it is added to the inventory page with a quantity of 0. The menu item is added to the send order page. ShelfLife allows for easy management and analysis of a restraunt's data all in one place.

The structure of the respitory is the ShelfLife_Deliverables folder which holds the code to create the database and the Shelf_Life folder containing the projects code. In the Shelf_Life folder, is a resources and views folder. The resources folder holds the css folder which stores the code for the styling of the html files. The resouces folder also hold the js folder which containes our node.js files, index.js and queries.js. The views folder holds each of out html and pug pages.

In order to run the program, first download the files. Using the shelflifeDBv6.txt file, create the database by copying and pasting the code into a new postgres template. In the index.js and queries.js file, change the dbconfig database, username and password to your database name, username and password. In these files, also change the rendering of html and pug pages to match the structure of your computer. To run the program open the index.js file in your terminal, and type the command, “node index.js”. Open a browser and type “localhost:3000/login”.

Please note, while you can download the code on your own computer to run it, you will have to change the file directories redirecting to diffrenet pages to match the structure of your computer. For your convience, we have uploaded two video demos in the main project folder of our website. One is a new user creating an account(new_user.mov), the other is a previous user who has past sales we can view(previous_user.mov).