WzGate

Getting Started

Prerequisites and how to run the services locally.

Prerequisites

  • Node.js 20+
  • PostgreSQL (the backend services each own a database)
  • RabbitMQ (for cross-service events)

Services and ports

ServicePortPurpose
CRM Backend3000Main CRM monolith
Integration Service3004External-provider webhook + sync hub
Admin Frontend3001Dashboard UI
This site3002Marketing + docs

Running a service

Each service is a standalone npm project. From inside its folder:

npm install
npm run start:dev   # backends (watch mode)
# or
npm run dev         # frontends

The backends use Prisma; generate the client and apply migrations with the project's prisma:* scripts before first run. See each service's own README for environment variables.

Building a public website instead?

If you are not running the platform but consuming it — building a marketing or real-estate site on top of a Wzgate tenant — you do not need any of the above. Start at Build your own website: it needs four values from the CRM and nothing installed locally.

On this page