First, you need to change the project name in the following files:
package.json
README.md
Specify the first version of this project in package.json
.
You need to install the following dependencies.
- Node.js: the min version required is
20
, the latest LTS version.
Recomendation: If you have installed
nvm
in your PC, only you need to run the following command:
nvm use
npm install
To set the default version, you can run the following command:
nvm alias default 20
- Run
npm install
in the root directory. This going to install all the required packages. - Run
npm run dev
to start the server on port8080
- Enjoy! 😊
If you need to change configuration you need to add .env
file and
push the following environment variables:
Environment variable | Description | Default value |
---|---|---|
NODE_ENV | Application execution environment (e.g., local, production) | local |
PORT | Port on which the application listens for requests | 8080 |
HEALTH_PING_THRESHOLD | Application health threshold (decimal value, 0.8 = 80%) | 0.8 |
HEALTH_DISK_SPACE_THRESHOLD | Disk space threshold in bytes (25MB = 26214400 bytes) | 26214400 |
Only run npm test
to execute all tests.