MERN-01 Project(STOCK MANAGEMENT)

Technologies • Getting Started • Collaborators • Contribute

Description

This project is a stock management system developed using the MERN (MongoDB, Express.js, React, and Node.js) stack. The goal is to allow users to add and update products and easily track their stock status.

The project consists of the following main components:

-MongoDB: Used as the database management system. All product and stock information is stored in MongoDB.
-Express.js: A minimal web framework for Node.js used to manage server-side code and define API endpoints.
-React: Used to create the user interface, providing dynamic and interactive user experiences.
-Node.js: Used to run JavaScript on the server side, forming the backend of the application.

💻Features

• Product Addition and Update: Users can add new products and update existing product information.
• Stock Tracking: Users can track the stock status of products.
• Stock Alerts: Users can receive alerts for products that fall below a certain stock level.
• Mobile Compatibility: The user interface is mobile-friendly, created using React and MUI, TailwindCSS.
• User Management: Users can register and log in to the system
• Populate:Mongoose method used to replace a path in a document with actual documents from other collections. It's commonly used to reference related documents.

🎨 Layout

ERD:

---

💻 Technologies

• Mongoose: An ODM (Object Data Modeling) library used to interact with MongoDB.
• Axios: A library used to manage HTTP requests.
• Redux: A library used for managing application state, utilized with Redux Toolkit.
• React Router: Used for navigation between pages in the application.
• dotenv: Used to manage environmental variables.

🚀 Getting started

Here you describe how to run your project locally

Cloning

How to clone your project

git clone https://github.com/mesbol6647/MERN-01-StokApp-.git

Starting

How to start your project

cd project-name
npm some-command-to-run

🤝 Collaborators

Special thank you for all people that contributed for this project.

Mesut Bolat

📫 Contribute

Here you will explain how other developers can contribute to your project. For example, explaining how can create their branches, which patterns to follow and how to open an pull request

1. git clone https://github.com/mesbol6647/MERN-01-StokApp-.git
2. git checkout -b feature/NAME
3. Follow commit patterns
4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

📝 How to create a Pull Request

💾 Commit pattern

Folder/File Structure: