Typst Online Editor

A professional, full-stack solution for cloud-based Typst authoring.

Explore Docs • API Reference • Report Bug

Key Features

Component	Highlights
Web Editor	Real-time preview, VSCode-like editor, template gallery, multi-user project sharing.
Compilation API	Typst to PDF/SVG rendering, isolated environments, Base64 image processing.
Architecture	Dockerized monorepo, Prisma ORM for seamless DB management, Next.js Server Actions.

Tech Stack

• Frontend: Next.js 16, TailwindCSS, Lucide Icons.
• Backend: Node.js API with Typst binary integration.
• Database: PostgreSQL with Prisma ORM.
• DevOps: Docker Compose, GitHub Actions (CI/CD).

Getting Started

Prerequisites

• Docker & Docker Compose
• Node.js (Optional, for local development)

One-Command Setup

The entire stack (App, API, Database) can be launched instantly:

git clone [https://github.com/ISC-HEI/typst-editor.git](https://github.com/ISC-HEI/typst-editor.git)
cd typst-editor
docker compose up -d --build

The editor will be available at http://localhost:3000 and the API at http://localhost:3001

For developement start, please see both README.

Configuration & Environment (optional)

To support frequent template searches and avoid GitHub API rate limiting, you must configure a Personal Access Token.

1. Create a Token: Go to GitHub Settings and generate a Personal Access Token (classic). No specific scopes are required for public repositories.
2. Update your .env: Add your token to the app/ environment file:

GITHUB_TOKEN=your_github_token_here

Note: Without this token, GitHub limits requests to 60 per hour per IP. With a token, this limit is increased to 5,000 requests per hour.

Repository Structure

.
├── app/            # Frontend Next.js application
├── server/         # Node.js Typst Compilation Service
├── docker-compose.yml
└── LICENSE