Node.js-Express.js-MongoDb-Mongoose-Project-Template

This is a backend template using Node.js, Express.js, MongoDB, Mongoose, TypeScript, Zod, and Yarn.

Prerequisites

• Node.js
• Yarn
• MongoDB
• Mongoose
• TypeScript
• Zod

Installation

Install using npx

1. Create a new project using the template:

npx @atik203/node-express-ts-starter my-project

1. Clone the repository:

git clone https://github.com/Atik203/Node.js-Express.js-MongoDb-Mongoose-Project-Template.git

2. Navigate into the project directory:

cd Node.js-Express.js-MongoDb-Mongoose-Project-Template

3. Install the dependencies:

yarn Install

4. Set up the MongoDB database URL in the .env file, following the format provided in the .env.example file.

Running the Application

1. Start the application in development mode:

yarn start:dev

2. Or, to start the application in production mode:

yarn start:prod

Building the Application

1. To build the application:

yarn build

Linting and Formatting

1. To lint the code:

yarn lint

2. To automatically fix linting errors:

yarn lint:fix

3. To format the code with Prettier:

yarn prettier

4. To automatically fix formatting errors with Prettier:

yarn prettier:fix

Enjoy using the application!