Skip to main content

Installation

Prerequisites

  • Node.js 22+ (LTS recommended)
  • pnpm (package manager)

Clone and install

git clone https://github.com/eff3ct0/teckel-ui.git
cd teckel-ui
pnpm install

Development server

pnpm dev

This starts Next.js with Turbopack on http://localhost:3000. The editor loads immediately; the backend connection is optional for editing but required for validation and execution.

Available scripts

ScriptDescription
pnpm devStart dev server with Turbopack
pnpm buildProduction build
pnpm startServe production build
pnpm lintRun ESLint
pnpm formatFormat with Prettier
pnpm format:checkCheck formatting
pnpm type-checkTypeScript type checking (tsc --noEmit)

Docker alternative

If you have Docker, you can run the editor alongside the Teckel Engine backend using Docker Compose:

services:
teckel-api:
image: ghcr.io/eff3ct0/teckel-api:latest
ports:
- "50051:50051"

teckel-ui:
build: .
ports:
- "3000:3000"
environment:
- TECKEL_HOST=teckel-api
- TECKEL_PORT=50051
depends_on:
- teckel-api
docker compose up

The editor will be available at http://localhost:3000 with the backend connected automatically.