Coffee Beans

About

This project is a 'Blue Bottle Coffee' themed coffee bean inventory management system built using React. The application is designed to showcase a variety of coffee beans, providing information such as brand, name, origin, roast type, a brief description, price, and availability. The user interface is built using React components, including dynamic rendering for detailed coffee bean information and forms for adding/editing new beans to the inventory. The application utilizes React state management to handle various states, allowing users to navigate between viewing, adding, editing, and deleting coffee beans. Additionally, the project features responsive design, making it suitable for a diversity of device sizes, and incorporates smooth scrolling functionality to enhance user experience.

Clicking 'EXPLORE' will scroll to the main list of coffee beans.

Each card will display a minimalistic glow and pointer effect when hovered over, indicative of clickability.

Once a card is clicked, its details are shown, where inventory management is accessible.

Technologies Used

• Github
• VSCode
• HTML
• CSS
• Bootstrap
• Javascript
• React
• draw.io

draw.io Diagram

Prerequisuites

Your computer or codespace should use Node.js version 16 or greater. For more information, see Node.js.

Application Setup

1. Clone the repository by either copying the link or entering the command in your terminal:

    $ git clone https://github.com/jeremyjosol/coffee-beans.git
   

2. After successfully cloning down the repository, navigate to the 'coffee-beans' directory:

    $ cd coffee-beans
   

3. Before you can use or deploy the project, make sure to install its dependencies. Run the following command in your terminal:

   $ npm install

   This command will read the package.json file and install all the required packages.

4. Once its dependencies are installed, you're ready to perform these available options:

$ npm start

• Runs the app in the development mode.

  • Open http://localhost:3000 to view it in your browser.

  • The page will reload when you make changes. You may also see any lint errors in the console.

$ npm run build

• Builds the app for production to the build folder.

  • It correctly bundles React in production mode and optimizes the build for the best performance.

  • The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

$ npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Known Bugs

No known bugs.

MIT License

Copyright (c) 2023 Jeremy Josol

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.