Browse documentation

Start here

Your first deployment

Connect a repository, configure your build, and take your application live.

On this page

1. Sign in and choose a team

For coding agents, the Markdown quickstart brings the setup and deployment workflow into a single file.

Open the Arvumi dashboard and choose Continue with GitHub. Complete onboarding by creating a team or accepting an invitation. Projects belong to teams.

Arvumi is a public beta for hobby and noncritical projects. Each GitHub identity can own at most three teams and create at most three teams in a rolling 30-day period, across Free and Pro. Deleting a team or recreating your account does not reset that allowance. Shared capacity is finite; plan ceilings do not reserve hardware. Read the beta terms and privacy information before deploying.

2. Connect your repository

A team owner or admin opens Teams → your team → GitHub repositories, chooses Authorize GitHub, and authorizes the same GitHub account used to sign in. Select the repositories the GitHub App may access, then choose a repository in Arvumi and click Grant to team.

Signing in and installing the GitHub App are separate from granting repository access to a team. If your organization requires approval or SSO, complete that step before returning to Arvumi. See repository access for troubleshooting.

Starting from scratch?

You can create a repository from a template in the team’s GitHub repositories screen. Choose a template that suits your project, then grant the new repository to your team.

3. Create a project

Choose New Project, select the team and granted repository, and give your project a name. Select the production branch, then check the build settings.

SettingWhat to enter
Root DirectoryThe application folder inside the repository. Leave empty for the repository root.
Install CommandYour dependency installation command, or the detected default.
Build CommandThe command that produces your application, such as npm run build.
Output DirectoryThe generated static files, relative to the application root, such as dist.

For example, a Vite application with an npm lockfile commonly uses npm ci, npm run build, and dist. Use your repository’s actual scripts and output. A plain HTML project does not need an install or build command; point the output directory at the folder containing the site.

For an application in a monorepo or a server-rendered framework, read Deployments & builds before changing detected settings.

4. Deploy and open your site

Create the project and follow its deployment in the dashboard. Open the build logs if installation or compilation fails. Once the deployment is ready, open its URL.

The project’s production address is your-project.arvumi.com. The dashboard also shows deployment URLs. Use the displayed address rather than guessing a preview URL.

5. Ship your next change

Commit and push a change to GitHub. Projects connected through the GitHub App receive push events automatically. In Settings → Deploy Config, Auto-promote production branch builds controls whether successful production-branch builds become live automatically.

Other branches can have preview deployments. Add environment variables, a custom domain, or a database as your project grows.