@fabernovel/pes-nx-plugin-nest NPM

@fabernovel/pes-nx-plugin-nest

Fabernovel's plugin for api applications

Table of contents

Usage
Installed
Contributing

Usage

Requirements

Inside your project's workspace, add this plugin as a dependency:

pnpm add -D -w @fabernovel/pes-nx-plugin-nest

If you do not have a workspace, refer to @fabernovel/pes-nx-plugin-workspace's README and create one.

Available generators

1. Application

In order to create an API Application, run the following command:

pnpm exec nx g @fabernovel/pes-nx-plugin-nest:application <name> [options]

Arguments	Description
`<name>`	Application name (will be requested by the cli if not provided)

Options	Default	Description	Required
`--tags`		Tags (string separated by commas). For example: `--tags="auth, user"`

Note: It's important to note that the Nest application requires a database to function properly. Without a database, the application will crash when served. After generating the Nest application, you have three options for providing a database:

Generate a docker-compose file that includes a Postgres database using the nx-plugin-docker tool. Docker documentation
Use your own local database.
Use a remote database.

Whichever option you choose, you'll need to specify the database identifiers in the .env.local file.

2. Library

In order to create an api library, run the following command:

pnpm exec nx g @fabernovel/pes-nx-plugin-nest:library <name> [options]

Arguments	Description
`<name>`	Library name (will be requested by the cli if not provided)

Options	Default	Description	Required
`--appName`		Application name (will be requested by the cli if not provided)	:eight_spoked_asterisk:
`--shared`	`false`	Add the library to libs//shared folder and tag it as shared
`--directory`		:warn: Use at your own discretion. Path of the library (string) after `/libs`. This is an opt out of our architecture.
`--service`	`true`	Include a service with the library
`--controller`	`true`	Include a controller with the library.
`--module`	`true`	Include a module with the library.
`--tags`		Tags (string separated by commas). For example: `--tags="auth,user"`