Giter Club home page Giter Club logo

tap-room's Introduction

Tay's Tap Room

React app created for a restaurant to keep track of kegs in stock, how many pints are left, and other details about the beer itself. This site incorporates Create, Read, and Delete functionality. Designed for an Epicodus independent project, showcasing React fundamentals.

Technologies Used

React

ES6

JSX

Bootstrap

Node

User Stories

  1. As a user, I want to see a list/menu of all available kegs. For each keg, I want to see its name, brand, price and alcoholContent (or perhaps something like flavor for a kombucha store).
  2. As a user, I want to submit a form to add a new keg to a list.
  3. As a user, I want to be able to click on a keg to see its detail page.
  4. As a user, I want to see how many pints are left in a keg. Hint: A full keg has roughly 124 pints.
  5. As a user, I want to be able to click a button next to a keg whenever I sell a pint of it. This should decrease the number of pints left by 1. Pints should not be able to go below 0.

Further Exploration

  1. As a user, I want to be able to delete a keg.
  2. As a user, I want a keg to update to say "Out of Stock" once it's empty.

Component Diagram

Setup & Installation

  1. You will need Node.js and a code editor like VSCode to download and setup this application
  • Check to see if you have Node installed by typing node -v in your terminal. If not you can download here
  1. Click the green Code button at the top of this GitHub page, select Download ZIP, unzip the file and open in your code editor. Or see step 3 for alternate method.
  2. Alternatively, open your terminal and navigate to where you want this repo to be downloaded. Then run the following 3 commands:
git clone https://github.com/taylulz/Tap-Room.git
cd Tap-Room
code .
  1. Now run the following command npm install to install necessary dependencies
  2. To see the application, run npm start which should automatically open in your browser. If it does not pop up automatically you may need to navigate to http://localhost:3000 in your browser manually

Support and contact

Please reach out here if you need any assistance

Future Features

Add an 'Edit Keg' button to 'Keg Details' page

Make a resuable form that both 'Add Keg' and 'Edit Keg' can use

Show different pictures/colors when a keg has <= 20 pints left

Known Bugs

no known bugs at this time

tap-room's People

Contributors

jd-fj avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.