Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digichanges/nexp-cli
Node Experience CLI
https://github.com/digichanges/nexp-cli
innovation-labx nodejs
Last synced: 10 days ago
JSON representation
Node Experience CLI
- Host: GitHub
- URL: https://github.com/digichanges/nexp-cli
- Owner: DigiChanges
- License: mit
- Created: 2021-05-02T21:33:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-07T14:15:52.000Z (10 months ago)
- Last Synced: 2024-12-27T17:09:49.659Z (17 days ago)
- Topics: innovation-labx, nodejs
- Language: JavaScript
- Homepage:
- Size: 2.69 MB
- Stars: 8
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
NExp-CLI
_This CLI is made to be able to quickly create the [NExp](https://github.com/DigiChanges/node-experience) 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](nodejs.org).
NPM (Node Package Manager): npm comes bundled with Node.js.
Docker : [Official Web](https://www.docker.com/)
Docker Compose : [Compose V2](https://docs.docker.com/compose/install/)
PNPM : Make sure you have PNPM installed. [Official Web](https://pnpm.io/es/)
# Installation
First, install nexp-cli using [npm](https://www.npmjs.com/)
```bash
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.
```bash
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`.
```bash
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](https://documenter.getpostman.com/view/10426172/Tz5je15Z)
### Boilerplate Documentation
[Boilerplate Documentation](https://digichanges.github.io/node-experience)
MIT © [Nathan Russo]()