Configuration (quikdb.json)

Add a quikdb.json file to your repository root to customize how QuikDB builds and runs your app. This file is optional — if you don't include one, QuikDB auto-detects your settings.

Full Reference

{
  "name": "my-app",
  "runtime": "nodejs",
  "buildCommand": "npm install && npm run build",
  "startCommand": "npm start",
  "port": 3000,
  "environmentVariables": {
    "NODE_ENV": "production"
  },
  "resources": {
    "cpuCores": 1,
    "ram": 1024,
    "storage": 5000
  },
  "replicaCount": 2
}

Fields

name

Display name for your deployment. If omitted, defaults to the repository name.

runtime

The runtime environment. Supported values:

nodejs | python | go | java | ruby | php | deno | rust | dotnet | static | bun

If omitted, QuikDB auto-detects from your repo files.

buildCommand

Shell command(s) to build your app. Examples:

• Node.js: npm install && npm run build
• Python: pip install -r requirements.txt
• Go: go build -o app .

startCommand

Shell command to start your app. Required unless you're using a Dockerfile. Examples:

• Node.js: npm start
• Python (FastAPI): uvicorn main:app --host 0.0.0.0 --port $PORT
• Go: ./app

The $PORT variable is injected automatically by QuikDB.

port

The port your app listens on. Defaults to 3000 if not specified.

environmentVariables

Key-value pairs injected at build time and runtime. You can also manage these from the dashboard UI. See Environment Variables.

resources

Resource allocation per container. Values are clamped to your tier limits.

Field	Type	Description
cpuCores	number	CPU cores (e.g., 0.5, 1, 2)
ram	number	RAM in MB (e.g., 512, 1024)
storage	number	Disk in MB (e.g., 2000, 5000)

See Plans for per-tier limits.

replicaCount

Number of replicas to deploy across different nodes. Range: 1 to 5, clamped to your tier's maximum.

Tier	Max Replicas
Hobby	1
Builder	2
Startup	3
Team	5

Examples

Express.js (minimal)

{
  "startCommand": "node server.js",
  "port": 8080
}

Next.js (with resources)

{
  "runtime": "nodejs",
  "buildCommand": "npm install && npm run build",
  "startCommand": "npm start",
  "port": 3000,
  "resources": {
    "cpuCores": 1,
    "ram": 1024
  }
}

FastAPI

{
  "runtime": "python",
  "buildCommand": "pip install -r requirements.txt",
  "startCommand": "uvicorn main:app --host 0.0.0.0 --port $PORT",
  "port": 8000
}

Go

{
  "runtime": "go",
  "buildCommand": "go build -o app .",
  "startCommand": "./app",
  "port": 8080
}