Back to Tuist

Tuist Server

server/README.md

4.191.82.2 KB
Original Source

Tuist Server

This repository contains the source code of the server-side application that extends the functionality of the Tuist CLI.

Contributing

Contributions to the Tuist Server require signing a Contributor License Agreement (CLA). Please see CLA.md for details before submitting pull requests that modify server components.

Development

Requirements

Set up

  1. Clone the repository: git clone https://github.com/tuist/tuist.git.
  2. Open the folder: cd server.
  3. Install system dependencies with: mise install.
  4. Start Postgres with: brew services start postgresql@16.
  5. Start ClickHouse with: mise run clickhouse:start
  6. Install dependencies: mise run install
  7. Create and set up the database: mise run db:setup
  8. Run the server: mise run dev
  9. Open the local URL for your current clone or worktree in your browser and log in with the pre-made test user account. With mise activate enabled, each checkout persists its own numeric suffix through Git metadata when available, while keeping the existing root .tuist-dev-instance file as a compatibility fallback. That suffix scopes the local service ports, MinIO ports, and the PostgreSQL and ClickHouse database names, while the local ClickHouse daemon itself stays shared across checkouts. For example, a suffix of 443 yields http://localhost:8523:
Email: [email protected]
Pass: 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.

To run additional features

  1. Clone the repository: https://github.com/tuist/tuist.git.
  2. Go to tuist/examples/xcode/generated_ios_app_with_frameworks.
  3. Change the url in Tuist.swift to the local URL for the current clone or worktree, for example http://localhost:8523.
  4. Run tuist auth to authenticate.
  5. You are now connected to the local Tuist Server! You can try running tuist cache and see the binaries being uploaded.