Quickstart

This walks a Next.js, Vite or Node application from a GitHub repository to a live URL on app.vinssi.ai. Budget ten minutes for the first run, most of it waiting for the build.

1. Sign in and install the GitHub App

Open the dashboard and sign in. A workspace is created for you on first login.

From the dashboard, choose Install GitHub App. GitHub asks which repositories the app may read; grant it only the repositories you intend to deploy. Vinssi requests read access to repository contents and metadata, nothing else. You can add repositories later from the same GitHub settings page.

When GitHub sends you back, the installation is connected to your workspace.

2. Create a project and connect a repository

Choose New project, give it a name, and pick the repository from the list. One repository connects to one project.

The project gets a permanent platform address of the form:

https://<project-slug>-<4 random characters>.app.vinssi.ai

The suffix keeps addresses unique across workspaces. You can attach your own domain once the first deploy is live.

3. Check what Vinssi detected

Before the first deploy, open Settings → Build. Vinssi fills in the install, build and start commands from your package.json and lockfile. Most projects need no changes. Two cases do:

• Monorepos. Set Root directory to the folder that contains the app's package.json, for example apps/web.
• Apps that do not read PORT. Vinssi runs your app with PORT=3000 and routes traffic to that port. Make sure your server listens on it.

The rules are in Supported apps and Build settings.

4. Add environment variables

Open Settings → Variables and add anything your build or runtime needs, such as an API key. Values are encrypted at rest and are available both while building and while running. See Environment variables. If the app needs Postgres, add a managed database under Settings → Database instead of setting DATABASE_URL by hand; Vinssi injects it for you.

Changes to variables take effect on the next deployment, not immediately.

5. Pick a plan

Deploys need an active plan on the project. Open Billing on the project, choose a plan, and complete checkout. Your signup credits are applied to the first invoice automatically. See Plans and limits.

6. Deploy

Press Deploy on the project page. Vinssi clones the default branch, runs the install and build commands in an isolated builder, and starts the app. Follow progress on the Deployments tab; build output streams in as it happens.

A first deployment typically takes two to five minutes. When the status turns to Live, open the platform address.

From now on, every push to the repository's default branch triggers a new deployment. Pushes to other branches are ignored.

7. Optional: use the CLI

If you prefer a terminal, or want to deploy from CI:

npx vinssi login
npx vinssi projects list
npx vinssi deploy <projectId>

See CLI.

If the first deploy fails

Open the failed deployment and read the build log. The most common causes are a missing DATABASE_URL (add a managed database or set the variable), an app that listens on a port other than 3000, and a monorepo without a root directory. Troubleshooting covers each with the fix.