This CLI is made to be able to quickly create the NExp boilerplate with all the content you want it to have. It allows you to choose between Mongoose and MikroORM when it comes to database persistence. This tool allows you to use NExp without the need to modify the code.

Pre-requisites

Before you begin, ensure that you have the following installed on your machine:

Node.js: Make sure you have Node.js installed. You can download it from Official Web.

NPM (Node Package Manager): npm comes bundled with Node.js.

Docker : Official Web

Docker Compose : Compose V2

PNPM : Make sure you have PNPM installed. Official Web

Installation

First, install nexp-cli using npm

npm install -g nexp-cli

Options

| Options | | |--- | --- | | create | initiate project creation |

Available ORM

NExp-cli provides support for two Object-Relational Mapping (ORM) frameworks:

| ORM | Database | | --- | --- | | Mongoose | MongoDB | | MykroORM | Postgres |

Usage

Creating a New Project

Use the following command to initiate project creation.

nexp-cli create

After running the above command, follow these steps:

• Write the name of the project.
• Choose the ORM.
• And wait for each action to complete.

Launching NExp :rocket:

Environment file

Copy .env.dev to .env

Install dependencies

To install dependencies, use pnpm.

pnpm install

Starting containers with Docker

To run your application using Docker, follow these steps to start the containers:

• Execute make dev command or STAGE=dev docker-compose up --build -d

NEXT

• Creation of entire domains

Docs

Postman Documentation

API Documentation

Boilerplate Documentation

Boilerplate Documentation

MIT © Nathan Russo