Skip to content

Burger Boss is an application that follows the MVC design pattern to create, update, and delete burgers from a list using Node, Express, Handlebars, MySQL and ORM.

License

Notifications You must be signed in to change notification settings

nsc9605/Burger-Boss

Repository files navigation

Burger Boss 🍔

License: MIT

Description

Burger Boss is an application that tracks burgers waiting to be devoured and those that have already been devoured. Following the MVC design pattern, this application was created using Node, Express, Express Handlebars, and MySQL. This application allows the user to build a list of burgers which will save to a database. The user can enter the name of the burger they would like to add into the form which will then appear in the list of burgers on the left side of the window. That burger can then be devoured and added to the list of devoured burgers on the right side of the screen.

📍 Click here to navigate to deployed app on Heroku! 📍

Table of Contents

Demonstration

Burger-Boss Gif

Features

  • The config folder houses the two javascript files:
    • connection.js code to connect node to MySQL.
    • orm.js which contains the methods used in order to retrieve and store data in the database.
  • The public folder contains the css and images files that represent the front-end.
  • The db folder contains the MySQL files including:
    • schema.sql which contain the SQL queries.
    • seeds.sql can contain a few starter burgers to populate the database with options.

Directory Structure

├── config
│   ├── connection.js
│   └── orm.js
│ 
├── controllers
│   └── burgers_controller.js
│
├── db
│   ├── schema.sql
│   └── seeds.sql
│
├── models
│   └── burger.js
│ 
├── node_modules
│ 
├── package.json
│
├── public
│   └── assets
│       ├── css
│       │   └── burger_style.css
│       └── img
|           └── Burger-Boss.gif
|           └── burger-right.jpg
|           └── icon.png
|           └── smiley.PNG
│   
│
├── server.js
│
└── views
  ├── index.handlebars
  └── layouts
      └── main.handlebars

Installation

The following dependencies are required to be installed for this application to run properly:

  npm i
  npm install express
  npm install express-handlebars
  npm install mysql
  npm install dotenv

Usage

Once all dependencies have been installed, users should run the following command in the terminal:

 `node server.js` 

This command and will instruct the app to begin listening on the LocalHost: PORT. This will then instruct users to either Cmd + Click for Mac users or Ctrl + Click on Windows which will open the browser with the following address or to enter the following in the web browser to deploy the application locally.

`localhost:8080`. 

A deployed link is provided for this specific project through Heroku.

License

License: MIT

This application is licensed under the MIT License.

Contribution

This project was creating with help from:

  • Provided material from: BootCamp Spot class
  • My tutor Eric Wallen
  • Help from other students in the class in a private study group.

This video helped get me started setting up my files and making sure I had all required dependencies installed:

Technologies

Contact Information

About

Burger Boss is an application that follows the MVC design pattern to create, update, and delete burgers from a list using Node, Express, Handlebars, MySQL and ORM.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published