Quickstart

WeekendBuilder takes a GitHub repo (or a built-in template) and gives you a live HTTPS URL in minutes. No config files, no infrastructure to manage.

Sign in

Go to app.weekendbuilder.io and click Sign in with GitHub. A popup opens, you authorise WeekendBuilder, and you’re in.

WeekendBuilder requests the read:user and repo scopes. repo is needed to create private repos for Quick Start projects and to clone private repos you deploy manually.

Deploy from a template

The quickest way to get something live:

1. On the dashboard, select the Quick Start tab
2. Pick a template — Node.js or Go
3. Enter a project name (becomes your subdomain, e.g. my-api.weekendbuilder.io)
4. Optionally change the Port if your app doesn’t listen on 3000
5. Click Deploy

WeekendBuilder creates a private GitHub repo in your account, pushes the template files, and starts a build. The project card shows creating while the build runs, then flips to running with a link to your live URL.

Deploy from a GitHub repo

If you already have a repo:

1. Select the GitHub Repo tab
2. Paste the repo URL (e.g. https://github.com/you/my-app)
3. Set the branch (defaults to main)
4. Enter a project name and optional port
5. Click Deploy

Your repo must have a Dockerfile at the root. WeekendBuilder clones it, runs docker build, and starts the container.

See Deploying from GitHub for more detail on private repos, build logs, and webhooks.

What happens next

Once a project is running:

• Your app is live at https://{slug}.weekendbuilder.io with automatic HTTPS
• Click the URL in the project card to open it
• Use the Environment panel to add env vars — they take effect on next redeploy
• Set up a webhook so pushes to your repo trigger automatic redeploys
• Add a custom domain if you want your own URL

Project limits

Each account can have up to 5 active projects. Delete a project to free up a slot.