Getting started
Your first project
Create a repository, push your code, and connect it to a project.
A project is an app the platform builds and deploys. It's linked to one repository, and every push to that repository deploys it.
1. Create a repository
In Cloud, open Repositories → New repository, or in the Git portal at https://git.gov.vin, open your organization and choose New repository. Names are 3–40 lowercase letters, numbers and dashes. You need the git:write scope (developers, admins and owners have it).
2. Create a key for Git
Git over HTTPS uses a key as the password.
- Open
https://id.gov.vin, select your organization and open Keys. Only owners and admins see this tab; if you're a developer, ask one of them for a key. - Name the key, choose the API type, and select
git:readandgit:write. - Optionally set an expiry in days (empty or 0 means it doesn't expire).
- Select Create key and copy it. It's shown once.
See Keys and service identities for the other key types.
3. Push your code
git remote add origin https://git.gov.vin/<org>/<repo>.git
git push -u origin mainWhen Git asks for credentials, enter any username and the key as the password. A credential helper saves you typing it again:
git config --global credential.helper osxkeychaingit config --global credential.helper storestore keeps the key in plain text in ~/.git-credentials. Use a keyring-backed helper if you have one.
Git for Windows asks Git Credential Manager to store it.
4. Create a project
In Cloud, open Overview → New project and fill in:
| Field | |
|---|---|
| Name | Shown in Cloud. Up to 64 characters. |
| Slug | Part of the project's hostnames. 2–40 lowercase letters, numbers and dashes. Changing it later changes the hostnames. |
| Framework | Next.js (server rendering and static pages) or Static (any static site). Node.js is listed but doesn't build yet. Coming soon |
| Location | Where the project's server code runs. The default comes from the platform's location registry. See Locations and regions. |
| Repository | The repository to deploy. You can also choose Connect later and link it in the next step. |
| Root directory | The app's folder when it isn't at the repository root (monorepos). |
5. Link the repository
If you chose Connect later, open the project's Settings → Git and connect the repository. Also check:
- Production branch (
mainunless you change it), under Git: pushes here deploy to production. - Build command and Output directory, under General: for static projects, when the detected ones aren't right.
Nothing deploys until a repository is linked. The next push builds it.