In this assignment, you'll create a burger logger with MySQL, Node, Express, Handlebars and a homemade ORM (yum!). Be sure to follow the MVC design pattern; use Node and MySQL to query and route data in your app, and Handlebars to generate your HTML.
When trying to connect remotely to your Heroku database on an open network such as a coffee shop, library, or even your University WiFi, it will be blocked. If you are experiencing a Heroku connection error, this could be why.
- This assignment must be deployed. Be sure to utilize the MYSQL Heroku Deployment Guide in order to deploy your assignment.
- Eat-Da-Burger! is a restaurant app that lets users input the names of burgers they'd like to eat.
- Whenever a user submits a burger's name, your app will display the burger on the left side of the page -- waiting to be devoured.
- Each burger in the waiting area also has a
Devour it!
button. When the user clicks it, the burger will move to the right side of the page. - Your app will store every burger in a database, whether devoured or not.
- Check out this video of the app for a run-through of how it works.
Having an active and healthy commit history on GitHub is important for your future job search. It is also extremely important for making sure your work is saved in your repository. If something breaks, committing often ensures you are able to go back to a working version of your code.
- Committing often is a signal to employers that you are actively working on your code and learning.
- We use the mantra “commit early and often.” This means that when you write code that works, add it and commit it!
- Numerous commits allow you to see how your app is progressing and give you a point to revert to if anything goes wrong.
- Be clear and descriptive in your commit messaging.
- When writing a commit message, avoid vague messages like "fixed." Be descriptive so that you and anyone else looking at your repository knows what happened with each commit.
- We would like you to have well over 200 commits by graduation, so commit early and often!
- This assignment must be deployed. * Please submit both the deployed Heroku link to your homework AND the link to the Github Repository!
- Create a GitHub repo called
burger
and clone it to your computer. - Make a package.json file by running
npm init
from the command line. - Install the Express npm package:
npm install express
. - Create a server.js file.
- Install the Handlebars npm package:
npm install express-handlebars
. - Install MySQL npm package:
npm install mysql
. - Require the following npm packages inside of the server.js file:
- express
- Inside your
burger
directory, create a folder nameddb
. - In the
db
folder, create a file namedschema.sql
. Write SQL queries this file that do the following: - Create the
burgers_db
. - Switch to or use the
burgers_db
. - Create a
burgers
table with these fields:- id: an auto incrementing int that serves as the primary key.
- burger_name: a string.
- devoured: a boolean.
- Create the
- Still in the
db
folder, create aseeds.sql
file. In this file, write insert queries to populate theburgers
table with at least three entries. - Run the
schema.sql
andseeds.sql
files into the mysql server from the command line - Now you're going to run these SQL files.
- Make sure you're in the
db
folder of your app. - Start MySQL command line tool and login:
mysql -u root -p
. - With the
mysql>
command line tool running, enter the commandsource schema.sql
. This will run your schema file and all of the queries in it -- in other words, you'll be creating your database. - Now insert the entries you defined in
seeds.sql
by running the file:source seeds.sql
. - Close out of the MySQL command line tool:
exit
.
- Make sure you're in the
- Inside your
burger
directory, create a folder namedconfig
. - Create a
connection.js
file insideconfig
directory. - Inside the
connection.js
file, setup the code to connect Node to MySQL. - Export the connection.
- Inside the
- Create an
orm.js
file insideconfig
directory. - Import (require)
connection.js
intoorm.js
- In the
orm.js
file, create the methods that will execute the necessary MySQL commands in the controllers. These are the methods you will need to use in order to retrieve and store data in your database. selectAll()
insertOne()
updateOne()
- Export the ORM object in
module.exports
.
- Import (require)
- Inside your
burger
directory, create a folder namedmodels
. - In
models
, make aburger.js
file. - Inside
burger.js
, importorm.js
intoburger.js
- Also inside
burger.js
, create the code that will call the ORM functions using burger specific input for the ORM. - Export at the end of the
burger.js
file.
- Inside
- In
- Inside your
burger
directory, create a folder namedcontrollers
. - In
controllers
, create theburgers_controller.js
file. - Inside the
burgers_controller.js
file, import the following: - Express
burger.js
- Create the
router
for the app, and export therouter
at the end of your file.
- Inside your
burger
directory, create a folder namedviews
. - Create the
index.handlebars
file insideviews
directory. - Create the
layouts
directory insideviews
directory. - Create the
main.handlebars
file insidelayouts
directory. - Setup the
main.handlebars
file so it's able to be used by Handlebars. - Setup the
index.handlebars
to have the template that Handlebars can render onto. - Create a button in
index.handlebars
that will submit the user input into the database.
- Create the
- Create the
All the recommended files and directories from the steps above should look like the following 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.png
│
│
├── server.js
│
└── views
├── index.handlebars
└── layouts
└── main.handlebars
- Please submit both the deployed Heroku link to your homework AND the link to the Github Repository!
Attempt to complete homework assignment as described in instructions. If unable to complete certain portions, please pseudocode these portions to describe what remains to be completed. Hosting on Heroku and adding a README.md are required for this homework. In addition, add this homework to your portfolio, more information can be found below.
Now that we have a backend to our applications, we use Heroku for hosting. Please note that while Heroku is free, it will request credit card information if you have more than 5 applications at a time or are adding a database. Please see Heroku’s Account Verification Information for more details.
Add a README.md
to your repository describing the project. Here are some resources for creating your README.md
. Here are some resources to help you along the way:
After completing the homework please add the piece to your portfolio. Make sure to add a link to your updated portfolio in the comments section of your homework so the TAs can easily ensure you completed this step when they are grading the assignment. To receive an 'A' on any assignment, you must link to it from your portfolio.
This is a really tough homework assignment, but we want you to put in your best effort to finish it. If you have any questions about this project or the material we have covered, please post them in the community channels in slack so that your fellow developers can help you! If you're still having trouble, you can come to office hours for assistance from your instructor and TAs.
When trying to connect remotely to your Heroku database on an open network such as a coffee shop, library, or even your University WiFi, it will be blocked. If you are experiencing a Heroku connection error, this could be why. Good Luck!