Getting Started

Start by cloning the repository:

git clone git@code.levl.work:levl/app.git

Using the dev CLI

In order to streamline the development process and harden it, a special CLI is maintained. Install it using:

# optional
bun install -g .

# now you are able to run shortened
# levl commands anywhere in the system:
levl run app

Alternatively, you can run all shown commands prefixed with bun run like:

bun run levl run app

Running the app

The app can currently only be run in development mode, as there’s no packaging process.

levl run app

Playground mode

By default, if there are no stored settings in the browser, the app will be run in playground mode.

This is a simplified legacy mode where server actions are run on the client, thus allowing the client to be run without a server. This mode is technically useless except for some niche use cases:

• running the demo
• for simple networkless tests
• for a generally simpler developer experience

Otherwise, the server mode is what really matters.

Server mode

This mode is what will run in real world contexts, and allows for multiple contributors to collaborate.

It needs a running server separate from the app:

levl run server

Run the app too, but don’t forget to switch the active connection to server mode. If the connection is successful, the indicator will be green.

levl run app