Creating a project
There are three ways to make one:
- Import a GitHub repository from New project in the dashboard. The project is linked to the repository, so pushes deploy automatically. See Git deployments.
- Start from a template. Pick a template, choose a name and whether the new repository is private, and Vantrex creates the repository in your GitHub account, copies the template into it and deploys it.
- Run
vtx linkin a folder to create a project that you deploy from the CLI.
The project name is free text. The slug is derived from it, becomes part of every deployment address and cannot be changed later.
The project pages
| Page | What it is for |
|---|---|
| Overview | The production address, the latest deployment and recent activity. |
| Deployments | Every deployment with its status, branch and address. Open one for its logs, or promote, redeploy or cancel it. |
| Runtime Logs | What a running server app prints. See Logs and observability. |
| Environment Variables | Values for builds and servers. See Environment variables. |
| Domains | Custom domains for the project. See Domains. |
| Settings | Build settings, the preview suffix, pausing and deletion. |
Settings
Most projects need no changes because Vantrex detects the framework. When you do need them:
| Setting | Meaning |
|---|---|
| Framework preset | Overrides detection. See Frameworks and builds. |
| Node.js version | The Node version used to install and build. |
| Install command | For example npm ci. Leave blank to use the default for your lockfile. |
| Build command | For example npm run build. |
| Output directory | The folder the build writes to, for example dist. |
| Root directory | A sub-folder of the repository, for monorepos. Everything is run from there. |
| Preview suffix | An optional addition to preview addresses. |
Changes apply to the next deployment. Existing deployments are never altered.
Pausing a project
Pausing takes the project offline without deleting anything. Visitors see a plain “paused” page until you resume it. Use it to stop traffic while you investigate a problem.
Deleting a project
Deleting a project removes its deployments, environment variables and domains. It cannot be undone, so the dashboard asks you to confirm first.