Documentation Index
Fetch the complete documentation index at: https://mintlify.com/nayalsaurav/deploy-your-app/llms.txt
Use this file to discover all available pages before exploring further.
Deploy Your App automatically detects your framework, package manager, and build scripts by inspecting your repository’s package.json and lockfiles — no manual configuration needed for most projects. However, when you need a custom build step, a non-standard server entry point, or you are working inside a monorepo, you can override these defaults through the project settings API or the dashboard.
Project Settings Fields
The following fields are accepted by PATCH /api/v1/projects/:id and control how deployments are built and started.
| Field | Type | Description |
|---|
name | string | Display name for the project |
defaultBranch | string | The branch to deploy on push. Defaults to main |
buildCommand | string | null | Override the build script (e.g. npm run build:prod). When null, the auto-detected default is used |
startCommand | string | null | Override the container start command (e.g. node dist/server.js). When null, the framework default is used |
rootDirectory | string | null | Subdirectory containing package.json, relative to the repository root (e.g. apps/web). Required for monorepos |
Auto-Detection Defaults
When no override is provided, the builder detects the framework by inspecting dependencies and devDependencies in package.json and applies the following defaults:
| Framework | Detected By | Output Directory | Default Start Command |
|---|
| Next.js | next dependency | .next | npm start (or package-manager variant, e.g. yarn start, bun x next start -p 3000) |
| Vite | vite dependency | dist | N/A — output is extracted as static files |
| Create React App | react-scripts dependency | build | N/A — output is extracted as static files (uses the vite Docker template) |
| Node.js | express, fastify, koa, @nestjs/core, hono, or an existing start script / index.js | (none) | npm start (or package-manager variant) |
npm run build, pnpm run build, yarn build, bun run build).
For Node.js projects that have no start script but do have an index.js at the repository root, the builder automatically falls back to node index.js as the suggested start command.
Package Manager Detection
The builder reads lockfiles in your repository (or rootDirectory) and selects the package manager accordingly. When multiple lockfiles are present a warning is logged and the highest-priority match wins.
| Lockfile | Package Manager | Install Command | Build Command |
|---|
pnpm-lock.yaml | pnpm | pnpm install --frozen-lockfile | pnpm run build |
yarn.lock | yarn | yarn install --frozen-lockfile | yarn build |
bun.lock / bun.lockb | bun | bun install --frozen-lockfile | bun run build |
package-lock.json | npm | npm ci | npm run build |
| (none found) | npm | npm install | npm run build |
Docker Build Arguments
Overrides are passed into Dockerfiles as build arguments. The Dockerfile templates live in infra/docker/ at the repository root, with one subdirectory per framework (nextjs, nodejs, vite) and one file per package manager (e.g. Dockerfile.npm, Dockerfile.pnpm).
| Build Arg | Description | Example |
|---|
BUILD_COMMAND | Overrides the build script executed during the Docker build stage | npm run build:production |
START_COMMAND | Overrides the CMD used to start the container (Node.js projects only) | node dist/server.js |
ROOT_DIR | Sets the working subdirectory inside the Docker build context | apps/api |
Updating Project Settings via API
curl -X PATCH https://your-domain.com/api/v1/projects/PROJECT_ID \
-H 'Content-Type: application/json' \
-b 'session=YOUR_SESSION_COOKIE' \
-d '{
"buildCommand": "npm run build:prod",
"startCommand": "node dist/server.js",
"rootDirectory": "apps/api"
}'
{
"message": "Project updated successfully",
"data": {
"project": {
"id": "PROJECT_ID",
"buildCommand": "npm run build:prod",
"startCommand": "node dist/server.js",
"rootDirectory": "apps/api"
}
}
}
null for the field:
curl -X PATCH https://your-domain.com/api/v1/projects/PROJECT_ID \
-H 'Content-Type: application/json' \
-b 'session=YOUR_SESSION_COOKIE' \
-d '{
"buildCommand": null,
"startCommand": null
}'
Monorepo Setup
When your repository contains multiple applications, set rootDirectory to the subdirectory that contains the package.json for the app you want to deploy — for example apps/web or packages/server. The builder copies the entire repository into the Docker build context and then switches into that subdirectory, so workspace-level lockfiles and shared packages remain accessible.
A package.json file must exist at the resolved rootDirectory path. If it is missing, the build fails immediately with a descriptive error:CRITICAL: package.json missing at /path/to/apps/web. Found files: ...
rootDirectory matches the exact path relative to your repository root and that the directory is committed to your branch.