kiselblat / burger

A full stack app, mcv organized, equipped with an orm, and hooked up to a database. Burger eating themed.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

burger

A full stack app, mcv organized, equipped with an ORM, and hooked up to a database. Burger eating themed.

Our future machine master recognizes our need to consume food for energy and concomitant desire for that experience to be gustatorily satisfactory. To that end, your benevolent machine overlord makes available Eat Da Burger! - a way of keeping track of what burgers you want to eat, and whether or not you've eaten them.

  1. Installation and Requirements
  2. How to Use
  3. How it Works
  4. About Me

Installation and Requirements

Eat Da Burger requires Node.js along with the express, express-handlebars, and mysql npm packages.

A package.json is provided, so to install all of these dependencies simply run:

npm i

In addition, Eat Da Burger! requires a running mySQL server with the burger_db database, as defined by the schema.sql file. The database connection settings can be edited in the following section of connection.js:

connection = mysql.createConnection({
    host: "localhost",          // Hostname
    port: 3306,                 // Port number
    user: "root",               // Login name
    password: "",               // Password
    database: "burger_db"       // Database name
  });

Once the mySQL server is running the correct database and Node.js has been installed along with all dependencies, Eat Da Burger can finally be called into existence with:

node server.js

How to Use

Once the server is running, point your browser to:

localhost:8080/

Alternately, see Eat Da Burger! in action at: https://burgerific.herokuapp.com/

There you will be presented with Eat Da Burger! - a burger tracking app. Use the text field to add burgers you'd like to eat. Once there you can use the cutlery icon to devour the burger. Once devoured, use the plus symbol if you want to eat the burger again. Use the minus symbol to remove the burger from the app altogether.

How it Works

Eat Da Burger is a mySQL and Node express server organized around the model-view-controller paradigm. The model, burger.js is javascript that describes the database's table, burger. The view is implemented with Handlebars, and is responsible for displaying the app's data and controls. Finally the controller, burger_controller.js, defines the routes for creating, reading, updating, and deleting burgers from the app.

About Me

Thomas Christ is a student in the Web Development Bootcamp at the University of Minnesota.

About

A full stack app, mcv organized, equipped with an orm, and hooked up to a database. Burger eating themed.


Languages

Language:JavaScript 71.5%Language:HTML 23.0%Language:TSQL 4.2%Language:CSS 1.4%