The following tools need to be installed on your local machine.

• Docker Desktop
• nvm

Run the install.sh script to install dependencies and setup needed symlinks.

sh install.sh

It is recommended to run install.sh every time you switch to the main branch.

The attribute naming must be identical to the naming in brevo

The following variables must be set manually

• BREVO_API_KEY
• BREVO_DOUBLE_OPT_IN_TEMPLATE_ID
• ECG_RTR_LIST_API_KEY
• BREVO_SENDER_NAME
• BREVO_SENDER_EMAIL
• CAMPAIGN_BASIC_AUTH_USERNAME
• CAMPAIGN_BASIC_AUTH_PASSWORD

dev-process-manager is used for local development.

pnpm run dev:demo

Demo will be available at

• Admin: http://localhost:8000/
• API: http://localhost:4000/
• Site: http://localhost:3000/

It is also possbile to start specific microservices

pnpm run dev:demo:api # (api|admin|site)

The docs will be available at http://localhost:3000/

npx dev-pm shutdown

// Removes docker volumes and all files and folder which are not managed in the repo (node_modules, lib,...)
// If you want to reset your development environment totally, run this command and ./install.sh afterwards.

./uninstall.sh