This guide walks you through importing a GitHub repository and getting your first application live on Deploy Your App. The platform handles framework detection, Docker image builds, and subdomain routing automatically — you just point it at a repo and click deploy.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.
Prerequisites: You need a running Deploy Your App instance before following this guide. If you haven’t set one up yet, see the Self-Hosting guide. You’ll also need a GitHub account with at least one repository you want to deploy.
Deploy Your First App
Sign In with GitHub
Open the Deploy Your App web dashboard in your browser and click Sign in with GitHub. You will be redirected to GitHub to authorize the OAuth application.The platform requests the following GitHub scopes to manage your repositories and webhooks:After authorizing, you will be redirected to your dashboard where your GitHub repositories are listed.
Import a Repository
On the dashboard, browse the list of your GitHub repositories. Click Import next to the repository you want to deploy.The platform reads your repository metadata — including the default branch — and opens the project configuration screen.
Configure Build Settings
Review and optionally customize your project settings. All fields are auto-detected from your repository, so this step is optional for most projects.
| Field | Description | Example |
|---|---|---|
| Name | Unique project name used in your subdomain | my-portfolio |
| Branch | Branch to deploy from | main |
| Root Directory | Monorepo sub-path to your app | apps/web |
| Build Command | Override the detected build command | bun run build |
| Start Command | Override the container start command | bun run start |
| Environment Variables | Key/value pairs encrypted at rest | API_URL=https://... |
Click Deploy
Click the Deploy button. The platform immediately queues a deployment job that executes the following steps in order:
- Clone — The builder service clones your repository at the specified branch using your GitHub OAuth token.
- Detect — The framework is identified from your project files (
next.config.*,vite.config.*,package.json, etc.). - Build — A Docker image is built using the appropriate Dockerfile for your stack (Next.js, Vite, Node.js, or Bun).
- Deploy — Static apps (Vite, Next.js static export) have their output uploaded to Cloudflare R2. Dynamic apps (Next.js SSR, Node.js) are started as isolated Docker containers.
- Route — The proxy service is updated to route your new subdomain to the running container or R2 bucket.
Your App Is Live
Once the deployment completes, your application is accessible at an auto-generated subdomain based on your project name:For example, a project named The subdomain is created automatically by the dynamic reverse proxy and is ready immediately after deployment — no DNS changes required on your end.
my-portfolio might be available at:What’s Next?
Import a Project
Learn the full project import flow, including advanced repository settings and GitHub App configuration.
Environment Variables
Manage encrypted secrets, add variables to running projects, and understand how they are injected at build and runtime.
Custom Domains
Map your own domain name to a deployed project and configure automatic TLS certificates via Caddy.
Build System
Understand how the platform detects frameworks and selects the right Dockerfile for each deployment.