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)

Searching Database…

26.9K ·GitHub
Что это такое?Onlook — это визуальный редактор с открытым исходным кодом, в основе которого лежит ИИ, для дизайна поверх вашей кодовой базы на Next.js + Tailwind. Вы редактируете элементы прямо в DOM браузера, как в графическом редакторе, а изменения в реальном времени переносятся в настоящий код.
Это больше похоже на Figma или на редактор кода?И то, и другое: визуальный интерфейс в стиле Figma (слои, элементы, перетаскивание) работает поверх настоящего редактора кода и живого предпросмотра. Проект позиционируется как альтернатива с открытым исходным кодом для Bolt.new, Lovable, V0, Replit Agent, Figma Make и Webflow.
Как начать что-то создавать в Onlook?Воспользуйтесь размещённым приложением или запустите его локально и импортируйте существующий проект на Next.js (или начните с нуля, с текста, изображения или готового шаблона). Полные инструкции по установке находятся на docs.onlook.com.
Работает ли Onlook с любым фронтенд-стеком?Пока что он создан специально для проектов на Next.js и TailwindCSS; поддержки других фреймворков и стилизации без Tailwind пока нет.
Чего ещё не хватает или что находится в разработке?Совместная работа над командами (комментарии, совместное редактирование в реальном времени помимо курсоров), панель компонентов с перетаскиванием, настройка MCP в проектах и поддержка проектов, не работающих на Next.js/Tailwind, пока не реализованы.
Можно ли развернуть его у себя вместо размещённого приложения?Да, редактор с открытым исходным кодом можно запустить локально (в комплекте есть Dockerfile и настройка docker-compose); размещённый продукт — это отдельное предложение, которое сейчас доступно в раннем доступе по листу ожидания.
Лицензия разрешительная?Она распространяется по лицензии Apache 2.0 — разрешительной лицензии с открытым исходным кодом без необычных ограничений.
Как редактирование элемента на холсте на самом деле меняет мой исходный код?Onlook загружает ваш проект в веб-контейнер, добавляет в запущенный код инструменты, которые связывают каждый элемент DOM с его местом в исходниках, и когда вы редактируете элемент визуально, сначала обновляется живой iFrame, а затем изменение записывается в настоящий файл кода.
Какой стек технологий лежит в основе Onlook?Next.js и TailwindCSS на фронтенде, tRPC для серверного интерфейса, Supabase и Drizzle для авторизации и базы данных, AI SDK с OpenRouter для доступа к LLM, а также Morph и Relace для быстрого применения правок; для среды выполнения и изоляции используются Bun и Docker.
Можно ли опубликовать приложение, которое я создал в Onlook?Да, вы можете развернуть проект за считанные секунды, создать ссылки для совместного доступа и подключить собственный домен прямо из редактора.
Может ли ИИ-чат вносить изменения в код самостоятельно?Да, у ИИ-чата есть прямой доступ к коду и инструменты для понимания и редактирования кода вашего проекта, а также можно поставить в очередь сразу несколько сообщений в чате.
Creator
onlook-dev
Size
81.1 MB
Stars
26.9K
Age
2y
Commits · 90 Days