> ## Documentation Index
> Fetch the complete documentation index at: https://filament.getgalaxy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Run Filament locally in three commands

## Prerequisites

You need:

* Docker with Compose
* Go
* `just`
* Node 22 with pnpm for the UI

Run `brew bundle` from the repo root to install the whole toolchain from the
Brewfile.

For Podman users, set `CONTAINER_ENGINE=podman` before running the commands below.
See [engine configuration](/pages/guides/contributing/local-development) for test requirements.

## Run it

<Steps>
  <Step title="Start local infra">
    Brings up Postgres 16 and NATS with JetStream via Compose. Wait
    for both containers to report healthy. The next step runs database
    migrations against this Postgres.

    ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    just infra
    ```
  </Step>

  <Step title="Run the app">
    This command:

    * Runs migrations
    * Starts the control plane (in-process dispatch) and the API server in the background
    * Waits until both `:8080/startupz` and `:8081/startupz` answer
    * Finally starts the UI dev server

    ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    just dev
    ```

    Once up:

    * The API listens on `:8080`
    * The control plane serves its health endpoints on `:8081`
    * The UI dev server runs on `localhost:5173`, proxying API calls to `:8080`
  </Step>

  <Step title="Run the tests (optional)">
    ```sh theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
    just test               # unit tests
    just test-integration   # integration tests using containers
    ```
  </Step>
</Steps>

## Next steps

Head to [Architecture](/pages/guides/concepts/architecture) to see how these
pieces relate, or [Connectors](/pages/connectors/overview/introduction) to see
what you can plug in as a source or sink.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.