Skip to content

Quick Start

Get the Vulcan development environment running in minutes.

Prerequisites

  • Git with SSH access to GitLab
  • Docker and Docker Compose
  • Node.js 20+ (for frontend)
  • .NET 10 SDK (for backend)
  • Make (for workspace commands)

Clone the Workspace

bash
# Clone with all submodules
git clone --recursive git@gitlab.hantverksdata.se:vulcan/vulcan-workspace.git
cd vulcan-workspace

# Or if you already cloned without --recursive
git submodule update --init --recursive

Start Development Services

bash
# Start databases and shared services
make dev

This starts:

  • 9 PostgreSQL databases (one per capability)
  • Redis for caching
  • Azurite for Azure Storage emulation

Start the Frontend

bash
# In a new terminal
make dev-web

Visit http://localhost:5173

Start a Backend Capability

bash
# Start the core setup service
make dev-be CAP=coresetup

The API will be available at http://localhost:5000

Available Commands

CommandDescription
make devStart databases and shared services
make dev-webStart frontend dev server
make dev-mobileStart mobile dev server (Expo)
make dev-be CAP=xStart specific backend capability
make testRun all tests
make stopStop all Docker services
make helpShow all available commands

Database Ports

Each capability has its own PostgreSQL database:

CapabilityPort
coresetup5432
leads5433
quotation5434
contracts5435
projects5436
invoicing5437
documents5438
ai5439
planning5440

Next Steps

Built with VitePress | v1.1.0