Launch an existing project

Requirements

• Install Docker
• Install Node.js version 16.14 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions installed on a single machine.
• Install Python version 3.8 (which can be checked by running python3 -v). You can use pyenv for managing multiple Python versions installed on a single machine.
• Install pnpm version 7 or above (which can be checked by running pnpm --version)
• Install nx version 15.4.5. After you install Node.js call npm install -g nx@15.4.5

Optional

• Install PDM version 2.3 or above (which can be checked by running pdm --version)
  • you need this one if you want to run pdm install command in packages/backend or packages/workers outside docker container
• Install AWS CLI version 2 (which can be checked by running aws --version)
  • you need this one if you want to deploy SaaS Boilerplate to AWS from your machine

Install dependencies

The project is configured to use pnpm workspaces, which means that you can install node_modules of all packages in repository, with single command:

pnpm install

Start the app

Start backend

nx run core:docker-compose:up

or a shorter version:

make up

This will run docker containers for all the backend services, in the detached mode.

Backend is running on http://localhost:5001.

Admin Panel is running on http://admin.localhost:5001.

Workers trigger server is running on http://localhost:3005.

Mailcatcher is running on http://localhost:1080. Check dedicated doc before using.

Start webapp

nx start webapp

Web app is running on http://localhost:3000.

Start documentation

nx start docs

Docs app is running on http://localhost:3006.