Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,31 +69,32 @@ builders.
## What you can do with Onlook:

- [x] Create Next.js app in seconds
- [x] Start from text or image
- [ ] Use prebuilt templates
- [ ] Import from Figma
- [ ] Start from GitHub repo
- [x] Start from text or image
- [ ] Use prebuilt templates
- [ ] Import from Figma
- [ ] Start from GitHub repo
Comment on lines +72 to +75
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Fix nested list indentation and a split bullet to satisfy markdownlint (MD007) and readability

The nested checklist items are indented with 4 spaces; your repo’s lint expects 2. Also, the “Detect and use Components” bullet is split across two lines, breaking the markdown structure.

Apply the following diffs:

-    - [x] Start from text or image
-    - [ ] Use prebuilt templates
-    - [ ] Import from Figma
-    - [ ] Start from GitHub repo
+  - [x] Start from text or image
+  - [ ] Use prebuilt templates
+  - [ ] Import from Figma
+  - [ ] Start from GitHub repo
-    - [x] Use Figma-like UI
-    - [x] Preview your app in real-time
-    - [x] Manage brand assets and tokens
-    - [x] Create and navigate to Pages
-    - [x] Browse layers
-    - [x] Manage project Images
-    - [ ] Detect and use Components – _Previously in
-          [Onlook Desktop](https://github.com/onlook-dev/desktop)_
+  - [x] Use Figma-like UI
+  - [x] Preview your app in real-time
+  - [x] Manage brand assets and tokens
+  - [x] Create and navigate to Pages
+  - [x] Browse layers
+  - [x] Manage project Images
+  - [ ] Detect and use Components – _Previously in [Onlook Desktop](https://github.com/onlook-dev/desktop)_
-    - [x] Real-time code editor
-    - [x] Save and restore from checkpoints
-    - [x] Run commands via CLI
-    - [x] Connect with app marketplace
+  - [x] Real-time code editor
+  - [x] Save and restore from checkpoints
+  - [x] Run commands via CLI
+  - [x] Connect with app marketplace
-    - [x] Generate sharable links
-    - [x] Link your custom domain
+  - [x] Generate shareable links
+  - [x] Link your custom domain
-    - [ ] Real-time editing
-    - [ ] Leave comments
+  - [ ] Real-time editing
+  - [ ] Leave comments

Also applies to: 77-85, 87-90, 93-97

🧰 Tools
🪛 LanguageTool

[grammar] ~72-~72: There might be a mistake here.
Context: ...conds - [x] Start from text or image - [ ] Use prebuilt templates - [ ] Imp...

(QB_NEW_EN)


[grammar] ~73-~73: There might be a mistake here.
Context: ...r image - [ ] Use prebuilt templates - [ ] Import from Figma - [ ] Start fr...

(QB_NEW_EN)


[grammar] ~74-~74: There might be a mistake here.
Context: ...lt templates - [ ] Import from Figma - [ ] Start from GitHub repo - [x] Visuall...

(QB_NEW_EN)


[grammar] ~75-~75: There might be a mistake here.
Context: ...m Figma - [ ] Start from GitHub repo - [x] Visually edit your app - [x] Use...

(QB_NEW_EN)

🪛 markdownlint-cli2 (0.17.2)

72-72: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


73-73: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


74-74: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


75-75: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

🤖 Prompt for AI Agents
In README.md around lines 72-75 (and also apply same changes to ranges 77-85,
87-90, 93-97), the nested checklist items are indented with 4 spaces and one
checklist bullet ("Detect and use Components") is split across two lines; change
nested list indentation to 2 spaces to satisfy MD007 and merge the split bullet
into a single line so each checklist item is a single continuous line; ensure
all nested checklist lines in the listed ranges use 2-space indentation and no
checklist text is broken across multiple lines.

- [x] Visually edit your app
- [x] Use Figma-like UI
- [x] Preview your app in real-time
- [x] Manage brand assets and tokens
- [x] Create and navigate to Pages
- [x] Browse layers
- [x] Manage project Images
- [ ] Detect and use Components – _Previously in
[Onlook Desktop](https://github.com/onlook-dev/desktop)_
- [x] Use Figma-like UI
- [x] Preview your app in real-time
- [x] Manage brand assets and tokens
- [x] Create and navigate to Pages
- [x] Browse layers
- [x] Manage project Images
- [ ] Detect and use Components – _Previously in
[Onlook Desktop](https://github.com/onlook-dev/desktop)_
- [x] Development Tools
- [x] Real-time code editor
- [x] Save and restore from checkpoints
- [x] Run commands via CLI
- [x] Connect with app marketplace

- [x] Real-time code editor
- [x] Save and restore from checkpoints
- [x] Run commands via CLI
- [x] Connect with app marketplace

- [x] Deploy your app in seconds
- [x] Generate sharable links
- [x] Link your custom domain
- [x] Generate sharable links
- [x] Link your custom domain
- [ ] Collaborate with your team
- [ ] Real-time editing
- [ ] Leave comments
- [ ] Real-time editing
- [ ] Leave comments

![Onlook-GitHub-Example](https://github.com/user-attachments/assets/642de37a-72cc-4056-8eb7-8eb42714cdc4)

Expand Down Expand Up @@ -182,6 +183,7 @@ For a full walkthrough, check out our
#### Sandbox and hosting

- [CodeSandboxSDK](https://codesandbox.io/docs/sdk) - Dev sandbox
- [E2B](https://e2b.dev/docs) - Dev sandbox
- [Freestyle](https://www.freestyle.sh/) - Hosting

#### Runtime
Expand Down
2 changes: 2 additions & 0 deletions apps/backend/supabase/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ max_rows = 100
[auth]
site_url = "https://onlook.com"
additional_redirect_urls = [
"https://onlook.internal",
"https://onlook.internal/auth/callback",
"http://localhost:3000",
"http://localhost:3000/auth/callback",
]
Expand Down
12 changes: 12 additions & 0 deletions apps/coderouter/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Prefix the API paths
URL_PATH_PREFIX="/coderouter"

# Do not share this secret key - used to generate JWT token used in the client
JWT_SECRET_KEY="Replace this with your own secret"

# Insert your custom API key here and store in your other backend as well.
# It'll be used for server-to-server authentication.
CODEROUTER_API_KEY=""

E2B_API_KEY="<Get your API key at https://e2b.dev>"
CSB_API_KEY="<Your api key from https://codesandbox.io/t/api>"
2 changes: 2 additions & 0 deletions apps/coderouter/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
.env
14 changes: 14 additions & 0 deletions apps/coderouter/Dockerfile.dev
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
FROM alpine:3.21.3

WORKDIR /app

COPY . .

# ENV CARGO_HOME=/project/etc/cargo
# ENV RUSTUP_HOME=/project/etc/rustup
ENV BUN_INSTALL=/usr/local/bin/bun

RUN apk add curl bash build-base
RUN curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.5"

CMD ["/usr/local/bin/bun/bin/bun", "dev"]
53 changes: 53 additions & 0 deletions apps/coderouter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
YOOOOOBLAHHHHHH

# Bun + TypeScript API Starter (Hono + Drizzle)

A batteries-included starter for building an API with **Bun**, **TypeScript**, **Hono**, and **Drizzle ORM**.
It includes: multi-database support (Postgres/MySQL/SQLite) with migrations, unit + functional tests,
OpenAPI generation, Swagger UI, TypeDoc, and a top-tier GitHub toolchain (Actions, Codecov, Renovate, Biome, Dependabot, GitHub Pages).

## Quickstart

```bash
bun install
cp .env.example .env
# choose a DB (sqlite by default)
bun db:generate # generate SQL from schema
bun db:migrate # run migrations
bun dev # start the API on http://localhost:3000
```

OpenAPI: http://localhost:3000/openapi.json
Docs (Swagger UI): http://localhost:3000/docs

### Scripts

- `bun dev` — run in watch mode
- `bun start` — production start
- `bun test` — run all tests with coverage
- `bun lint` — Biome lint/format check
- `bun fmt` — format files with Biome
- `bun db:generate` — generate migrations via drizzle-kit
- `bun db:migrate` — apply migrations
- `bun openapi` — regenerate OpenAPI JSON
- `bun docs` — build TypeDoc to `site/typedoc`

### Multi-DB

Set `DRIZZLE_DB` to `postgres` | `mysql` | `sqlite` and provide `DATABASE_URL` accordingly.
SQLite works out-of-the-box (`DATABASE_URL=file:./dev.sqlite`).

### GitHub Pages (Docs)

The `pages.yml` workflow builds and deploys:

- `/openapi.json` -> `/site/api/openapi.json`
- Swagger UI -> `/site/api/`
- TypeDoc -> `/site/typedoc/`
A small `site/index.html` links to both.

Enable Pages in **Settings → Pages** (source: GitHub Actions).

## License

MIT
5 changes: 5 additions & 0 deletions apps/coderouter/biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://biomejs.dev/schemas/2.1.4/schema.json",
"formatter": { "enabled": true, "formatWithErrors": true },
"linter": { "enabled": true }
}
Loading