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.
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
First, install nexp-cli using npm
npm install -g nexp-cli| Options | |
|---|---|
| create | initiate project creation |
NExp-cli provides support for two Object-Relational Mapping (ORM) frameworks:
| ORM | Database |
|---|---|
| Mongoose | MongoDB |
| MykroORM | Postgres |
Use the following command to initiate project creation.
nexp-cli createAfter running the above command, follow these steps:
- Write the name of the project.
- Choose the ORM.
- And wait for each action to complete.
Copy .env.dev to .env
To install dependencies, use pnpm.
pnpm installTo run your application using Docker, follow these steps to start the containers:
- Execute
make devcommand orSTAGE=dev docker-compose up --build -d
- Creation of entire domains
MIT © Nathan Russo