Mykol5 / inventoryapp

simple inventory app performing CRUD operations

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Inventory Management System

This is a simple inventory management system built using Next.js, Redux Toolkit, and Material-UI. It allows users to view, add, update, and delete products from an inventory.

Features

  • View Products: Displays a list of all products in the inventory.
  • Add Product: Allows the user to add a new product to the inventory.
  • Edit Product: Allows the user to update details of an existing product.
  • Delete Product: Allows the user to remove a product from the inventory.
  • View Product Details: Displays detailed information about a specific product.

Tech Stack

  • Next.js: A React framework for server-side rendering and static site generation.
  • Redux Toolkit: A state management library for managing application state.
  • Material-UI: A popular React UI framework for building responsive and modern web applications.

Getting Started

Prerequisites

  • Node.js (v18.17.0 or later)
  • npm (v10.8.0 or later) or yarn (v1.x or later)

Installation

  1. Clone the repository:

    git clone https://github.com/Mykol5/inventoryapp.git
    cd inventory-app
  2. Install dependencies:

    npm install

    or

    yarn install
  3. Run the development server:

    npm run dev

    or

    yarn dev

    Open http://localhost:3000 with your browser to see the result.

Project Structure

  • components/: Contains React components used in the application.
  • pages/: Contains the Next.js pages for routing.
  • redux/: Contains Redux slices and store configuration.
  • public/icons/: Contains icon files used in the application.

Usage

Viewing Products

Navigate to the home page to see a list of all products. Click on "View Details" to see detailed information about a specific product.

Adding a Product

Click on the "Add Product" button on the home page. Fill in the product details in the form and submit to add the product to the inventory.

Editing a Product

Click on the edit icon next to a product in the list. Update the product details in the form and submit to save the changes.

Deleting a Product

Click on the delete icon next to a product in the list to remove it from the inventory.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any bugs or improvements.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

About

simple inventory app performing CRUD operations


Languages

Language:TypeScript 97.4%Language:CSS 2.2%Language:JavaScript 0.4%