/tap-room

A website built in React to monitor and update a taproom's inventory.

Primary LanguageJavaScript

Tap Inventory Tracker

A website for tracking inventory for a taproom. April 24, 2020

By: Benjamin Thom

Description

A website built in React to track a taproom's taps by name, brand, price, style, and quantity. The application utilizes a tap list, a new tap form, and tap-specific details view to accurately monitor inventory.

Component Tree

component tree

Web Page Preview

component tree

Specification User Stories

  • A user should be able to create, read, and update taps in the taproom.
  • A user should be able to sell a pint from a tap listed on the tap list, which reduces tap quantity by 1.
  • When the quantity of a tap is 0, the tap should say "out of stock". A user should not be able to reduce the quantity of a tap below 0.

Setup/Installation Requirements

Node install

For macOS:

If Homebrew is not installed on your computer already, then install Homebrew by entering the following two commands in Terminal:

Install Git with the following command:

  • $ brew install git

Next, install Node.js by entering the following command in Terminal:

  • $ brew install node
For Windows:

Please visit the Node.js website for installation instructions.

Install this application

Clone this repository via Terminal using the following commands:

Next, install npm at the project's root directory via the following commands:

  • $ npm install
  • $ npm run build

Open the contents of the directory in a text editor or IDE of your choice (e.g., to open the contents of the directory in Visual Studio Code on macOS, enter the command "code ." in Terminal).

Known Bugs

No known bugs at this time.

Support and Contact Details

Have a bug or an issue with this application? Open a new issue here on GitHub.

Technologies Used

  • Git
  • JavaScript
  • npm
  • Webpack
  • React

License

MIT

Copyright (c) 2020 Benjamin Thom