For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quickstart

Go from sign-up to your first deploy in under five minutes.

This quickstart gets you to your first deploy as fast as possible. We'll skip most of the configuration — you can refine things later once you have something running.

Steps

1

Create your workspace

Sign in and create a new workspace. The workspace name appears in URLs and email notifications, so pick something recognisable.

yourcompany
2

Connect a source

Link a repository from your version control provider, or upload a project directly.

Click Connect repository, authenticate with your provider, and select the repository to import. The platform will detect your framework automatically.

Drag and drop a project folder, or use the CLI:

platform deploy ./my-project

Browse the template gallery and click Use template. A new project will be created from the template in your workspace.

3

Configure your build

Most projects work with the auto-detected settings. If yours doesn't, override them in Project settings → Build.

build:
  command: npm run build
  output: dist/
  node: 20
4

Deploy

Hit Deploy. Your project will build and go live at a generated subdomain. You can promote it to production or add a custom domain at any time.

First builds typically take 1–3 minutes. Subsequent builds are faster because dependencies are cached.

What's next?

You've shipped something — now make it yours.

Custom domainsPermissionsAutomations

Was this helpful?