Skip to content

How to set up my project?

Kiet edited this page Dec 3, 2024 · 12 revisions

Just hit play

There is no setup or extra dependencies necessary. Just hit the play button in the bottom toolbar.

AI Chat Auto-Complete

Running into issues?

Make sure your URL is pointing at the correct location. If it opens in your browser, it should open in Onlook.

Screenshot 2024-12-03 at 5 43 00 PM

Open the terminal to see if your app is running.

terminal

Still have issues?

Reach out to us in Discord or Email we always reply within a few minutes (unless sleeping).

Previous method (no longer needed):

Use our CLI

You should be able to run setup with our CLI command.

In your project root, run:

npx onlook setup

It currently supports:

  • Next.js
  • CRA
  • Webpack
  • Remix
  • Vite

Do it manually

If not currently supported by the CLI, you can also manually set up the projects. See instructions for each framework:

Check out the demo projects


Don't see your framework?

Open a request here.