Sumon-DevCoder/assignment-2

MyExpressTypeScriptApp

MyExpressTypeScriptApp is a Node.js application built with Express, TypeScript, and Mongoose. It includes validation with Joi and other useful tools.

Table of Contents

• Prerequisites
• Installation
• Running the Application
• Configuration
• Project Structure
• Scripts
• Testing
• Deployment
• Contributing
• License
• Contact

Prerequisites

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

• You have installed Node.js (version 14.x or later).
• You have installed MongoDB and it is running on your local machine or you have access to a MongoDB Atlas cluster.
• You have a package manager like npm (comes with Node.js) or yarn.

Installation

To install the application, follow these steps:

1. Clone the repository:

   git clone https://github.com/SumonRahman24/assignment-2.git

2. Navigate to the project directory:

   cd MyExpressTypeScriptApp

3. Install dependencies:

   npm install

   or if you use yarn:

   yarn install

Running the Application

To run the application locally, follow these steps:

1. Ensure you are in the project directory.
2. Compile the TypeScript code:

   npm run build

   or if you use yarn:

   yarn build

3. Start the application:

   npm run dev

   or if you use yarn:

   yarn start

4. Open your web browser and go to:

   http://localhost:5000
   

Configuration

The application requires a configuration file to connect to the MongoDB database and set up other environment variables. Here’s how you can set up your configuration:

1. Create a .env file in the root directory.

2. Add the following environment variables in the .env file:

   PORT=5000