Skip to content

chloehellberg/TapRoomRedux

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


|| Beer Haus Tap Room - With Redux ||


___________________________

By: Chloe Hellberg
Built November 21st, 2020, Revisited December 4th, 2020


Table of Contents


🌐 About the Project

📖 Description

This project utilizes React to create an imaginary tap room where a bar can store and track their kegs. Application allows a user to:

  • See full list/menu of all available kegs.
  • Submit a form to add a new keg to the list.
  • Ability to click on a keg to see its details.
    • For Each Keg: See its name, brand, price, quantity and style/type.
  • See how many pints are left in a keg (full keg has roughly 124 pints).
  • Ability to click a button on each keg to sell a pint of it and quantity of keg will descrease the number of pints left by 1. Pints should not be able to go below 0.
  • Ability to "restock" keg once keg is empty and hits 0 pints.
  • Keg will update to say "Almost Empty" when it hits 10 pints left and "Out of Stock" when it hits 0 pints left.

Tap Room Components Diagram

🦠 Known Bugs

🛠 Built With


🏁 Getting Started

📋 Prerequisites

Interactive Development Environment

 To view or edit the document which may include some HTML code, you will need an code editor or text editor. The popular open-source choices for an code editor are Atom and VisualStudio Code.

  1. Code Editor Download:
  2. Click the download most applicable to your OS and system.
  3. Wait for download to complete, then install -- Windows will run the setup exe and macOS will drag and drop into applications.
  4. Optionally, create a GitHub Account

⚙️ Setup and Use

Cloning

  1. Click 'Clone or download' to reveal the HTTPS url ending with .git and the 'Download ZIP' option.
  2. Open up your system Terminal or GitBash, navigate to your desktop with the command: cd Desktop, or whichever location suits you best.
  3. Clone the repository to your desktop: $ git clone https://github.com/chloehellberg/TapRoomRedux
  4. Run the command cd tap-room to enter into the project directory.
  5. View or Edit:
    • Code Editor - Run the command atom . or code . to open the project in Atom or VisualStudio Code respectively for review and editing.
    • Text Editor - Open by double clicking on any of the files to open in a text editor.
  6. In the project directory (tap-room), type npm start to run the application in development mode. Open http://localhost:3000 to view it in the browser. Page will reload if you make edits. You will also see any lint errors in the console.

Download

  1. Click 'Clone or download' to reveal the HTTPS url ending with .git and the 'Download ZIP' option.
  2. Click 'Download ZIP' and extract the directory to whichever location suits you best.
  3. Open by double clicking on any of the files to open in a text editor.

Learn More


🤝 Contributors

Author GitHub Email
Chloe Hellberg chloehellberg chloe.hellberg@gmail.com

✉️ Contact and Support

If you have any feedback or concerns, please contact one of the contributors.


⚖️ License

This project is licensed under the MIT License. Copyright (C) 2020 Chloe Hellberg. All Rights Reserved.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Return to Top

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published