This is backend for a Technical Lead Assessment project to manage orders. The system allows businesses to manage their orders and provides pagination for efficiently handling of large datasets.

• Getting Started
  • Prerequisites
  • Installation
• Backend
  • Pagination
• API Documentation
• Deployment
• Contributing
• License
• Contact

These instructions will help you set up and run the project on your local machine for development and testing purposes.

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

• Node.js: You need to have Node.js installed. You can download it from https://nodejs.org/.

• MongoDB: MongoDB is used as the database for this project. You can download and install it from https://www.mongodb.com/try/download/community.

1. Clone the repository:

   git clone https://github.com/faaiz-hadaina/duplo-backend.git

2. Navigate to the project directory:

   cd duplo-backend

3. Install the required dependencies:

   npm install

4. Configure the environment variables (if necessary):

   # Create an environment variable configuration file
   cp .env.example .env
   
   # Update the .env file with your configuration

5. Start the backend development servers:

   npm run dev

   The backend on http://localhost:3000.

   Preview URL: https://duplo.edperfect.com/

The backend of the Order Management System is built using Node.js and Express. It handles order management, pagination, and interacts with a MongoDB database to store order data. Additionally, it provides APIs for listing business orders.

The backend includes pagination functionality for listing orders. Pagination parameters such as page and limit can be specified in API requests to control the number of results returned. This allows for efficient retrieval of large datasets.

You can find the API documentation for this project here. It provides detailed information on the available endpoints for order listing and management.

To deploy the app to a live server, follow these steps:

1. Set up a production-ready server environment with Node.js, Express, and MongoDB.

2. Deploy the backend code to a Node.js hosting service (e.g., Heroku, AWS, Azure) and configure the necessary environment variables.

3. Set up a production-ready MongoDB database and update the database connection details in the backend environment variables.

Contributions to this project are welcome! If you would like to contribute, please follow these guidelines:

• Fork the repository.
• Create a new branch for your feature or bug fix.
• Make your changes and test thoroughly.
• Submit a pull request with a clear description of your changes.

This project is licensed under the [License Name] License - see the LICENSE.md file for details.

If you have any questions or feedback, please feel free to contact us at [[email protected]].