Building from source

Instructions

You can build and run Onlook from source. The steps are:

1. Install Bun

Our preferred Node runtime is Bun (better alternative to npm)

2. Clone the repo from GitHub

git clone https://github.com/onlook-dev/desktop.git

Linux/MacOS

curl -fsSL https://bun.sh/install | bash

Windows

powershell -c "irm bun.sh/install.ps1 | iex"

Note: For Windows, make sure you have windows build tools installed

bun install --global --production windows-build-tools

3. Install dependencies

Navigate to the repo

cd desktop

Run install command

bun i

4. Run the app

bun dev

Env variables

Certain env variables will enable extra features for the app such as authentication, AI, analytics, etc. If .env.example files exists, copy and rename the file .env and fill in the API keys for the feature you'd like to enable.

Example: https://github.com/onlook-dev/desktop/blob/main/apps/studio/.env.example

The app will still work with no env variables enabled.