Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 1.6 KB

README.md

File metadata and controls

38 lines (30 loc) · 1.6 KB

Inventory App

The Inventory App is a web-based tool for managing and organizing items in a simple and efficient manner. It provides a RESTful API that supports the standard Create, Read, Update, and Delete (CRUD) functions.

Features

  • User-friendly interface for managing items
  • RESTful API for programmatic access to inventory data
  • CRUD functionality for adding, editing, and deleting items
  • Easy integration with other web-based applications

Built With

Live Demo

Getting Started

To use the Inventory App, you will need to have Node.js and MongoDB installed on your machine. Once you have installed these dependencies, follow these steps:

  1. Clone the repository
  2. Install the required dependencies using npm install
  3. Create a .env file in the root directory
  4. Add a field called MONGODB_CONNECTION_STRING= to the .env file
  5. Paste in your MongoDB connection string with credentials.
    ex. "mongodb+srv://<user>:<password>@cluster0.xxxxxxx.mongodb.net/?retryWrites=true&w=majority"
  6. Start the server using npm run dev
  7. Navigate to http://localhost:5173 in your web browser to use the app

Contributing

Contributions to the Inventory App are always welcome! If you would like to contribute, please follow these steps:

Fork the repository Create a new branch for your changes Make your changes and test them thoroughly Create a pull request with a detailed description of your changes