https://github.com/mejia-dev/burlap-coffee-with-redux
ReactJS project using Redux for state storage, demonstrating full CRUD implementation
https://github.com/mejia-dev/burlap-coffee-with-redux
crud react react-redux reactjs redux state-management
Last synced: 3 months ago
JSON representation
ReactJS project using Redux for state storage, demonstrating full CRUD implementation
- Host: GitHub
- URL: https://github.com/mejia-dev/burlap-coffee-with-redux
- Owner: mejia-dev
- Created: 2023-12-15T17:14:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-16T01:00:01.000Z (over 2 years ago)
- Last Synced: 2025-02-27T07:15:45.852Z (over 1 year ago)
- Topics: crud, react, react-redux, reactjs, redux, state-management
- Language: JavaScript
- Homepage: https://mejia-dev.github.io/burlap-coffee-with-redux/
- Size: 691 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Burlap Coffee Co. Inventory Tracker with Redux
#### This project acts as a functional inventory tracker for a coffee company.
Created by: [github.com/mejia-dev](https://github.com/mejia-dev)
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Component Diagram
## Technologies Used
* ReactJS
* Redux
* HTML
* CSS
* JavaScript
* webpack
* npm
* Jest
* ESLint
* Babel
* Dotenv
## Description
This project utilizes Redux to allow users to adjust coffee inventory levels. This is not intended to be customer-facing and is instead meant for employees to manage inventory.
Features:
* Allows users to add, view, edit, and delete inventory levels of coffee beans.
* Displays warnings if stock is getting low.
More information autogenerated by Create React App can be found below in the "React Information" section.
## Setup/Installation Requirements
Option 1: GitHub Pages:
* Navigate to [https://mejia-dev.github.io/burlap-coffee-with-redux](https://mejia-dev.github.io/burlap-coffee-with-redux) in your browser of choice.
Option 2: Manual Project Setup
* Clone this repository to your desktop by, running the following command from your Git Bash console:
```bash
git clone https://github.com/mejia-dev/burlap-coffee-with-redux.git
```
* Navigate to the project directory:
```bash
cd burlap-coffee-with-redux
```
* Run the following command to install dependencies:
```bash
npm install
```
* Run a live server to view the project:
```bash
npm run start
```
## Known Bugs
* none
## License
MIT License
Copyright (c) 2023 github.com/mejia-dev
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.
#### React Information
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.\
Open [http://localhost:3000](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 test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `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!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `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.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).
### Code Splitting
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
### Analyzing the Bundle Size
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
### Making a Progressive Web App
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
### Advanced Configuration
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
### Deployment
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
### `npm run build` fails to minify
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)