express-api-template/README.md

Project for quick express.js setup

# express-api-template

![](https://img.shields.io/github/v/release/iamharshil/express-api-template?style=flat-square)
![](https://img.shields.io/github/license/iamharshil/express-api-template?style=flat-square)
![](https://img.shields.io/npm/v/node?style=flat-square)
![](https://img.shields.io/github/stars/iamharshil/express-api-template?style=flat-square)

The express-api-template is a starter template for building a Node.js API using the Express.js framework. It is designed to provide a quick and easy way to get started with building a new API project, with support for both JavaScript and TypeScript.

This template includes the following features:

-   A pre-configured Express.js server with basic mongodb setup.
-   Support for both JavaScript and TypeScript.
-   A simple example route to get you started.
-   A pre-configured MVC architecture.
-   A pre-configured ESLint configuration with examples.
-   A pre-configured Prettier and Rome.
-   A new scalable architecture.

To get started with this template, simply run the following command:

## Installation

To create a new project using this template, run the following command:

`npx express-api-template`

After command runs successfully follow this steps

1. Step 1 [OPTIONAL]:

    - If you want to update all the dependency to the latest version

    ```bash
    npm update
    # or
    yarn update
    # or
    pnpm update
    ```

2. Step 2:

    - Run this command to install all the dependency

    ```bash
    npm install
    # or
    yarn install
    # or
    pnpm install
    ```

3. Step 3:
    - Set up you're .env file.
    - Run "start" or "dev" command in terminal using you're package manager to start you're project.

## Connect with me

[![Instagram](https://img.shields.io/badge/-Instagram-E4405F?style=flat-square&logo=instagram&logoColor=white)](https://instagram.com/iam_harshil)
[![GitHub](https://img.shields.io/badge/-GitHub-181717?style=flat-square&logo=github&logoColor=white)](https://github.com/iamharshil)
[![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat-square&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/harshil-chudasama)