jhf1203 / burger

An app that allows you to name a burger, and eat it!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

readMe - burger

Table Of Contents

  1. Description
  2. Installation
  3. Usage
  4. Collaborating
  5. Contact

Description

This is a simple app that allows the user to name a burger of their choice, virtually "devour" it at their leisure, and then re-create it if desired. While this program may not have much of a professional application, sometimes it's just nice to hone full-stack skills on something fun.

Burger is powered by mySQL and Express on the back-end, with Express Handlebars to render the HTML and jQuery on the front-end for API communication.


Instructions

Deployment: https://stormy-taiga-92457.herokuapp.com/

From a user perspective this app is hosted on Heroku so there is no installation required. Should one want to use the code for this application, the dependencies needed are Mysql, express, and express-handlebars.


Usage

Usage for this app is very straightforward.

  • Once the page loads, you will see a list on the left of "un-devoured" burgers, with an option to devour. These are ones that you or previous users have submitted. On the right you will see burgers that have been "devoured, and an option to "Make Another."
  • Clicking on the corresponding buttons noted above will move the given burger to the other category/column.
  • At the bottom of the page is an input field where you can name your own burger to be added to the list. Simply type what you would like for your burger to be named and click the "submit" button, and it will be added to the list of "un-devoured" burgers.

You can view a demonstration of the application below:

image


Collaborating

Got an idea? A bug to report? Or even a thought on how the application could run more efficiently? Log it here as an issue, and we'll talk about it!


Contact Me

Jim Faulkner


License

This application is licensed under the MIT License

About

An app that allows you to name a burger, and eat it!


Languages

Language:JavaScript 50.3%Language:Handlebars 27.0%Language:CSS 22.7%