/express-ts-assignment-2

Label-2 Assignment Documentation

Primary LanguageTypeScript

Label-2 Assignment Documentation

This repository contains the code for an Express.js application using TypeScript, designed to handle product and order management. This README provides an overview of the project structure, setup instructions, and usage guidelines.

Table of Contents

Setup Instructions

Follow these steps to set up and run the project locally:

  1. Clone the repository:

    git clone https://github.com/mahamodulhasanmoon/express-ts-assignment-2.git
cd label-2-assignment

  2. Install dependencies:

    npm install

  3. Configure environment variables:

    Create a .env file in the root directory and add the following:

    PORT=4000
MONGODB_URI=your_mongodb_connection_string

  4. Compile TypeScript:

    npm run build

  5. Start the server:

    npm start

API Documentation

The API is documented using OpenAPI 3.0. The openapi.yaml file contains the complete documentation.

Endpoints

https://assignment2-api.brainicsoft.xyz/docs

contact-information

For any queries or issues, please contact: