Inventory and Stock Management System

This is a simple inventory management system built using Node.js, Express, TypeScript, and MongoDB. It helps businesses manage their inventory efficiently.

Table of Contents

• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• API Documentation
• Contributing

Features

• User authentication and authorization.
• Add, update, delete, get a single and get all products.
• Contact us, user will be able to report any problems.
• RESTful API for easy integration with other systems.

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js and npm installed.
• MongoDB installed and running.
• Git for version control.

Installation

1. Clone the repository:

   git clone https://github.com/dchief1/ism-backend.git
   

2. Navigate to the project directory:

   cd ism-backend
   

3. Install dependencies:

   npm install
   

4. Configure environment variables:
   • Create a '.env' file in the project root.
   • Add the necessary environment variables (e.g., database URL, JWT secret, etc.):

5. Start the application:

   npm run dev
   

Usage

1. Access the application in your web browser or API client at 'https://ism-app-api.onrender.com'.
2. Sign up and create an account or log in if you already have one.
3. Use the provided API endpoints to manage your inventory.

API Documentation

For detailed API documentation, please refer to the 'https://documenter.getpostman.com/view/18943407/2s9YCAPVCh'.

Contributing

We welcome contributions from the community! If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix:   git checkout -b feature/your-feature-name.
3. Make your changes and commit them:   git commit -m "Add your feature" .
4. Push to your fork:   git push origin feature/your-feature-name.
5. Create a pull request to the main branch of the original repository.