This project is a robust Inventory Management and Support Ticketing Application built using the MERN stack (MongoDB, Express, React, Node.js). It serves as the Capstone Project for KodeGo, showcasing the seamless integration of these technologies to efficiently manage inventory and handle support tickets.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
- Node.js installed on your machine.
- MongoDB instance set up (local or cloud-based).
A step by step series of examples that tell you how to get a development env running
-
Clone the Repository:
-
Install Dependencies:
# Install frontend dependencies cd frontend npm i # Install backend dependencies cd ../backend npm i
-
Configure Environment Variables:
• Create a .env file in the server directory and set your environment variables, including database connection details, and secret keys.
NODE_ENV = deployment PORT = 8000 MONGO_URI = mongodb+srv://<username>:<password>@<db>.k4sbzml.mongodb.net/?retryWrites=true&w=majority JWT_SECRET = <dbpw>
-
Install concurrently:
-
Add script to package.json from the root directory:
"start": "node backend/server.js", "server": "nodemon backend/server.js", "client": "npm start --prefix frontend", "dev": "concurrently \"npm run server\" \"npm run client\""
-
Run the Application:
npm run dev
-
Access the Application:
• Open a web browser and navigate to http://localhost:5000 to access the application.
Explain how to run the automated tests for this system
Explain what these tests test and why
```powershell
Give an example
```
Explain what these tests test and why
```powershell
Give an example
```
Add additional notes about how to deploy this on a live system
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Ritz Carl Feliciano - Capstone Project - HexeCalibre
-
- Alvin Castor - Capstone Project - akosialbean
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details.
- Hat tip to anyone whose code was used
- Inspiration
- etc