@fabernovel/pes-nx-plugin-docker

Fabernovel's plugin for docker databases.

Table of contents

1. Usage
2. Contributing

Usage

Requirements

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

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

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

Available generators

1. Docker-compose file initialisation

In order to create a docker-compose file, run the following command:

pnpm exec nx g @fabernovel/pes-nx-plugin-docker:init-docker-compose [options]

It will create docker-compose.yml file inside support/docker.

2. Postgres

In order to create a Postgres database, run the following command:

pnpm exec nx g @fabernovel/pes-nx-plugin-docker:postgres [options]

It will update the docker-compose.yml file and create an init-db.sh script.

| Options | Default | Description | Required | | ---------------- | ------------- | ------------------------------------------------------------ | -------- | | --databaseName | defaultdb | Database name (will be requested by the cli if not provided) | | | --username | defaultuser | Username (will be requested by the cli if not provided) | |

Note: A root user is created in addition of the default user (root/password).

Contributing

See the Contributing file.