onlook README

The project's README from github.com/onlook-dev/onlook. As one markdown file: README.md.

header image

Onlook

The design tool for AI-native designers — now in early access.
Onlook makes designing on top of your codebase effortless. Craft exceptional experiences with AI in code.

→ Join the waitlist

👨‍💻👩‍💻👨‍💻 We're hiring engineers in SF! 👩‍💻👨‍💻👩‍💻


View Demo · Report Bug · Request Feature

Discord LinkedIn Twitter

中文 | Español | Deutsch | français | Português | Русский | 日本語 | 한국어

This is the open-source visual editor that started Onlook (Next.js + Tailwind). The hosted product we're building next, for AI-native designers, is in early access via the waitlist above.

An Open-Source, Visual-First Code Editor

Craft websites, prototypes, and designs with AI in Next.js + TailwindCSS. Make edits directly in the browser DOM with a visual editor. Design in realtime with code. An open-source alternative to Bolt.new, Lovable, V0, Replit Agent, Figma Make, Webflow, etc.

What you can do with Onlook:

Onlook-GitHub-Example

Getting Started

Use our hosted app or run locally.

Usage

Onlook will run on any Next.js + TailwindCSS project, import your project into Onlook or start from scratch within the editor.

Use the AI chat to create or edit a project you're working on. At any time, you can always right-click an element to open up the exact location of the element in code.

image

Draw-in new divs and re-arrange them within their parent containers by dragging-and-dropping.

image

Preview the code side-by-side with your site design.

image

Use Onlook's editor toolbar to adjust Tailwind styles, directly manipulate objects, and experiment with layouts.

image

Documentation

For full documentation, visit docs.onlook.com

To see how to Contribute, visit Contributing to Onlook in our docs.

How it works

architecture
  1. When you create an app, we load the code into a web container
  2. The container runs and serves the code
  3. Our editor receives the preview link and displays it in an iFrame
  4. Our editor reads and indexes the code from the container
  5. We instrument the code in order to map elements to their place in code
  6. When the element is edited, we edit the element in our iFrame, then in code
  7. Our AI chat also has code access and tools to understand and edit the code

This architecture can theoretically scale to any language or framework that displays DOM elements declaratively (e.g. jsx/tsx/html). We are focused on making it work well with Next.js and TailwindCSS for now.

For a full walkthrough, check out our Architecture Docs.

Our Tech Stack

Front-end

Database

AI

Sandbox and hosting

Runtime

Contributing

image

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also open issues.

See the CONTRIBUTING.md for instructions and code of conduct.

Contributors

Contact

image

License

Distributed under the Apache 2.0 License. See LICENSE.md for more information.

onlook (onlook-dev/onlook)

figma
Searching Database…

26.9K ·GitHub
What is this?Onlook is an open-source, AI-first visual editor for designing on top of your Next.js + Tailwind codebase. You edit elements directly in the browser DOM like a design tool, and the changes map back to real code in real time.
Is this more like Figma or more like a code editor?It's both: a Figma-like visual UI (layers, elements, drag-and-drop) sitting on top of a real code editor and live preview, positioned as an open-source alternative to Bolt.new, Lovable, V0, Replit Agent, Figma Make, and Webflow.
How do I start building something with Onlook?Use the hosted app, or run it locally and import an existing Next.js project (or start from scratch, text, an image, or a prebuilt template). Full setup instructions live at docs.onlook.com.
Does Onlook work with any frontend stack?Right now it's built specifically for Next.js and TailwindCSS projects; support for other frameworks and non-Tailwind styling isn't available yet.
What's still missing or in progress?Team collaboration (comments, live co-editing beyond real-time cursors), a drag-and-drop components panel, MCP setup in projects, and support for non-Next.js/non-Tailwind projects are all listed as not yet done.
Can I self-host it instead of using the hosted app?Yes, the open-source editor can be run locally (it ships with a Dockerfile and docker-compose setup); the hosted product is a separate offering currently in early access via waitlist.
Is the license permissive?It's licensed under Apache 2.0, a permissive open-source license with no unusual restrictions.
How does editing an element on the canvas actually change my source code?Onlook loads your project into a web container, instruments the running code to map each DOM element back to its source location, and when you edit the element visually it updates it first in the live iFrame, then writes the change back into the actual code file.
What's in the tech stack behind Onlook?Next.js and TailwindCSS on the frontend, tRPC for the server interface, Supabase and Drizzle for auth/database, AI SDK with OpenRouter for LLM access plus Morph and Relace for fast-apply edits, and Bun with Docker for the runtime and sandboxing.
Can I deploy the app I build in Onlook?Yes, you can deploy your project in seconds, generate shareable links, and attach a custom domain directly from the editor.
Can the AI chat make code changes on its own?Yes, the AI chat has direct code access and tooling to understand and edit your project's code, and you can queue up multiple chat messages at once.
Creator
onlook-dev
Size
81.1 MB
Stars
26.9K
Age
2y
Commits · 90 Days