Deploy from GitHub

Nept can build and deploy your app on every push to a GitHub repository. This is the recommended workflow for teams: your production URL always reflects your main branch, and every pull request gets its own preview URL.

Connect GitHub

1. Go to Connect GitHub.
2. Authorize Nept for the accounts or organizations you want to deploy from.
3. Choose which repositories Nept can access.

Create a project from a repository

1. In the dashboard, click New project.
2. Pick a connected repository.
3. Choose a branch (typically main for production).
4. Nept detects the framework (Next.js, React, Vite, Docker, etc.) and pre-fills build settings.
5. Add environment variables.
6. Click Deploy.

What happens on push

Every commit to a tracked branch triggers:

1. A shallow git checkout of the commit.
2. A build using the configured command.
3. A deployment to a fresh URL.
4. If the branch is your production branch, traffic on your custom domain is moved to the new deployment.

Branch previews

Non-production branches get their own URLs so you can share work in progress before merging. Each preview gets its own environment variables if configured.

Per-branch environment variables

Set environment variables that apply only to specific environments:

nept env add DEBUG true --target preview
nept env add SENTRY_DSN https://... --target production

See Environment Variables.

Deployment logs

Live build and runtime logs are available for every deployment. See Deployment Logs.

Next steps

• Deploy a Next.js app
• Deploy a React app
• Deploy a Vite app
• Custom Domains