Getting Started

Getting Started

View as Markdown

Create your Atlasflow account, connect GitHub, and deploy your first project.

Atlasflow deploys containerized applications from GitHub repositories. This guide walks through account setup, connecting GitHub, and creating your first project.

Create an account

Sign up at Atlasflow and verify your email address with the 6-digit code we send you. You'll land in your personal workspace after signing in.

A workspace is the billing and resource boundary that contains your projects. You can create more workspaces later, for example to separate personal projects from team work.

Choose a plan

Deployments require an active subscription. Pick a plan during onboarding or from your workspace billing settings:

PlanMinimum monthly usageBest for
Hobby$5Side projects and experiments
Pro$20Production apps and small teams
Team$100Teams shipping at scale

Each plan includes that amount in usage credits every month, and you're only billed for resource usage beyond your credits. See Plans for the full comparison.

Connect GitHub

Atlasflow uses a GitHub App to access your repositories. When you create a project, you'll be prompted to install the Atlasflow GitHub App on your account or organization.

Grant access to the repositories you want to deploy. You can adjust repository access later in your GitHub settings, and reconnect from a project's settings if access changes.

Create a project

  1. Open your workspace and choose New project.
  2. Select a GitHub repository. Each project maps to one repository.
  3. Configure the project:

    • Project name: defaults to the repository name.
    • Root directory: subdirectory containing your app (use / for the repo root). See Monorepos.
    • Dockerfile path: path to your Dockerfile (defaults to Dockerfile). If no Dockerfile exists, Atlasflow auto-detects your stack and builds your app. See Supported frameworks.
  4. Optionally add environment variables during setup.
  5. Create the project.

After creation, Atlasflow triggers an initial deployment from your repository's default branch.

Make sure your app listens on port 3000 and responds to GET / with a 2xx status before deploying. See Container requirements.

Next steps