Skip to main content

Deploying Your App

Deploy an application from a GitHub repository through QuikDB Compute.

Step 1: Connect GitHub​

From the Compute dashboard, choose Connect GitHub & deploy and authorize only the repositories you want QuikDB to read.

Step 2: Select the source​

Choose the repository, branch and service directory. The service directory matters for monorepos: it must contain the application and the build files that QuikDB should use.

Step 3: Review build settings​

Confirm the values shown by Compute:

  • Runtime — the detected runtime or application type
  • Build command — how dependencies and production output are built
  • Start command — how the application process starts
  • Port — the port the application listens on
  • Environment variables — values required at build or runtime

QuikDB checks explicit project configuration and an existing Dockerfile before relying on detected commands. Detection is a suggestion, not a guarantee. Correct any value that does not match the repository.

Step 4: Deploy​

When you start the deployment, QuikDB queues the work, assigns qualifying capacity, builds the application, starts it and runs health checks before routing traffic. The deployment detail page shows stored build and runtime logs.

Deployment states​

StateMeaning
pendingThe deployment exists and is waiting to start.
buildingQuikDB is preparing the application.
deployingThe process is starting and health checks are running.
queuedQualifying capacity is temporarily unavailable; QuikDB will retry.
liveThe application is healthy and serving traffic.
partialSome requested replicas are live and others did not start.
failedThe build, start command or health check did not complete.
stoppedThe owner stopped the deployment.
sleepingThe plan permits sleeping and the application is currently inactive.

Redeploying safely​

A redeploy retains the deployment identity while QuikDB builds and starts the next version. Check the logs and live state before treating the change as successful. If a redeploy fails, correct the source or settings and retry; do not assume an unverified rollback completed.

Common failure checks​

  1. Read the first relevant build or runtime error.
  2. Confirm the repository, branch and service directory.
  3. Confirm that the start command launches the intended process.
  4. Listen on the PORT value supplied by QuikDB.
  5. Add every required environment variable.
  6. Confirm that an application-owned Dockerfile can build from the selected context.

If the problem remains, search QuikDB Help or email cs@quikdb.net with the deployment ID and first relevant error line. Never send secrets or complete environment files.