Server

Source: github.com/tuist/tuist/tree/main/server

What it is for#

The server powers Tuist’s server-side features like authentication, accounts and projects, cache storage, insights, previews, registry, and integrations (GitHub, Slack, and SSO). It is a Phoenix/Elixir application with Postgres and ClickHouse.

How to contribute#

Contributions to the server require signing the CLA (server/CLA.md).

Set up locally#

bash

cd server
mise install

# Dependencies
brew services start postgresql@16
mise run clickhouse:start

# Install dependencies + set up the database
mise run install

# Run the server
mise run dev

Open http://localhost:8080 in your browser. In development, the login page includes a Log in as test user button that signs you in with the pre-made account ([email protected] / tuistrocks).

Note

First-party developers can load encrypted secrets from priv/secrets/dev.key. External contributors don't need this key — the server runs locally without it. OAuth, Stripe, and other third-party integrations will be disabled, but core functionality works.

Local Helm testing#

You can spin up the full stack on your machine using kind and the included mise tasks. This builds the Docker images locally, creates a kind cluster, installs the chart, and port-forwards all services automatically:

bash

# Deploy everything (builds images from source)
mise run helm:up --license "YOUR_LICENSE_KEY"

# Include the observability stack (Grafana, Prometheus, Loki, Tempo)
mise run helm:up --license "YOUR_LICENSE_KEY" --observability

# Check status
mise run helm:status

# Tear down
mise run helm:down

Prerequisites: docker, kind, helm, and kubectl.

Tests and formatting#

Tests: mix test
Format: mise run format