update README.md

README.md

@@ -3,21 +3,19 @@ REST API facade template for microservices that interacts with the MultiversX bl
 ## Quick start
 
 1. Run `npm install` in the project directory
-2. Optionally make edits to `config.yaml` or create `config.custom.yaml` for each microservice
+2. Optionally make edits to `config/config.yaml` and/or `.env` files
 
 ## Dependencies
 
 1. Redis Server is required to be installed [docs](https://redis.io/).
 2. MySQL Server is required to be installed [docs](https://dev.mysql.com/doc/refman/8.0/en/installing.html).
 3. MongoDB Server is required to be installed [docs](https://docs.mongodb.com/).
 
-You can run `docker-compose up` in a separate terminal to use a local Docker container for all these dependencies.
+You can run `docker-compose up` (or `docker-compose up -d` as detached) in a separate terminal to use a local Docker container for all these dependencies.
 
 After running the sample, you can stop the Docker container with `docker-compose down`
 
-## Available Features
-
-These features can be enabled/disabled in config file
+## Available Features / Modules
 
 ### `Public API`
 
@@ -50,9 +48,45 @@ Use `admin` for user and password fields. Then navigate to `Dashboards` -> `Temp
 
 This is a MultiversX project built on Nest.js framework.
 
-### `npm run start:mainnet`
+### Environment variables
+
+In order to simplify the scripts, the templates will use the following environment variables:
+
+- `NODE_ENV`
+
+**Description**: Defines the environment in which the application runs. This influences various configuration settings.
+
+**Possible Values**: `mainnet`, `testnet`, `devnet`, `infra`
+
+**Usage**: Determines the environment-specific configurations and behaviors of the application.
+
+- `NODE_APP`
+
+**Description**: Specifies which part of the application to start.
+
+**Possible Values**: `api`, `cache-warmer`, `transactions-processor`, `queue-worker`
+
+**Usage**: Selects the specific application module to run.
+
+- `NODE_DEBUG`
+
+**Description**: Enables or disables development debug mode.
+
+**Possible Values**: `true`, `false`
+
+**Usage**: When set to true, the application starts in debug mode, useful for development.
+
+- `NODE_WATCH`
+
+**Description**: Enables or disables development watch mode.
+
+**Possible Values**: `true`, `false`
+
+**Usage**: When set to true, the application starts in watch mode, which automatically reloads the app on code changes.
+
+
+### `npm run start`
 
-​
 Runs the app in the production mode.
 Make requests to [http://localhost:3001](http://localhost:3001).
 
@@ -62,48 +96,68 @@ Redis Server is required to be installed.
 
 ```bash
 # development watch mode on devnet
-$ npm run start:devnet:watch
+$ NODE_ENV=devnet NODE_APP=api NODE_WATCH=true npm run start
+or
+$ NODE_ENV=devnet NODE_WATCH=true npm run start:api
 
 # development debug mode on devnet
-$ npm run start:devnet:debug
+$ NODE_ENV=devnet NODE_APP=api NODE_DEBUG=true npm run start
+or
+$ NODE_ENV=devnet NODE_DEBUG=true npm run start:api
 
-# development mode on devnet
-$ npm run start:devnet
+# development mode
+$ NODE_ENV=devnet NODE_APP=api npm run start
+or
+$ NODE_ENV=devnet npm run start:api
 
 # production mode
-$ npm run start:mainnet
+$ NODE_ENV=mainnet NODE_APP=api npm run start
+or
+$ NODE_ENV=mainnet npm run start:api
 ```
 
 ## Running the transactions-processor
 
 ```bash
 # development watch mode on devnet
-$ npm run start:transactions-processor:devnet:watch
+$ NODE_ENV=devnet NODE_APP=transactions-processor NODE_WATCH=true npm run start
+or
+$ NODE_ENV=devnet NODE_WATCH=true npm run start:transactions-processor
 
 # development debug mode on devnet
-$ npm run start:transactions-processor:devnet:debug
+$ NODE_ENV=devnet NODE_APP=transactions-processor NODE_DEBUG=true npm run start
+or
+$ NODE_ENV=devnet NODE_DEBUG=true npm run start:transactions-processor
 
 # development mode on devnet
-$ npm run start:transactions-processor:devnet
+$ NODE_ENV=devnet NODE_APP=transactions-processor npm run start
+or
+$ NODE_ENV=devnet npm run start:transactions-processor
 
 # production mode
-$ npm run start:transactions-processor:mainnet
+$ NODE_ENV=mainnet npm run start:transactions-processor
 ```
 
 ## Running the queue-worker
 
 ```bash
 # development watch mode on devnet
-$ npm run start:queue-worker:devnet:watch
+$ NODE_ENV=devnet NODE_APP=queue-worker NODE_WATCH=true npm run start
+or
+$ NODE_ENV=devnet NODE_WATCH=true npm run start:queue-worker
 
 # development debug mode on devnet
-$ npm run start:queue-worker:devnet:debug
+$ NODE_ENV=devnet NODE_APP=queue-worker NODE_DEBUG=true npm run start
+or
+$ NODE_ENV=devnet NODE_DEBUG=true npm run start:queue-worker
 
 # development mode on devnet
-$ npm run start:queue-worker:devnet
+$ NODE_ENV=devnet NODE_APP=queue-worker npm run start
+or
+$ NODE_ENV=devnet npm run start:queue-worker
 
 # production mode
-$ npm run start:queue-worker:mainnet
+$ NODE_ENV=mainnet npm run start:queue-worker
 ```
 
 Requests can be made to http://localhost:3001 for the api. The app will reload when you'll make edits (if opened in watch mode). You will also see any lint errors in the console.​