Project Name

Description

📦 Getting Started

⚙️ Installation

For start to develop with this project follow the steps below:

• Install the dependencies (Use npm preferably):

npm install

• Run the application in mode development:

npm run dev

This project uses the following environment variables:

Available variables	Description
DOMAIN	The domain on listen.
MODE	The mode of execution.
PORT	The port of access to server.

Note. The environment variables are set by the .env file. You can follow the structure to change the name of .env.example file.

🚀 Docker for production

For to run the docker containers, you need to use the implementation:

• docker-compose up -d to launch the docker container.

• docker-compose down to stop the docker contianer.

Note. For only launch DB environment, exec docker-compose up -d postgres in mode silence.

⚙️ Installation

This image uses environment variables for configuration.

Available variables	Description
DOMAIN	The domain on listen.
MODE	The mode of execution.
PORT	The port of access to container.
DB_USER	The user to container database.
DB_PASSWORD	The password to container database.
DB_PORT	The port of access to container database.

😎 Author

Emmanuel Rodriguez - Full Stack Developer