Skip to main content
This guide takes you from a new Gapstack account to a project on the dashboard. When you finish, Gapstack can provision AWS resources in your account and deploy artifacts from your GitHub repositories, such as Lambda code.

​
Prerequisites

Before you start, you need:
  • An email you can use to sign up
  • An AWS account where you have AdministratorAccess (recommended). Root user access works, but is not recommended.
  • A GitHub account that can install the Gapstack GitHub App
Gapstack deploys into your AWS account. The CloudFormation stack you create only grants Gapstack permission to provision resources there. You own the infrastructure.
1

Sign up

Open https://app.gapstack.dev/ and create an account. If you already have one, sign in.
2

Create your organization

After you sign in, Gapstack asks you to create an organization. This is your company or team in the product. The API calls it a tenant.
  1. Enter an Organization name you will recognize, such as your company name.
  2. Do not include spaces in the name.
  3. Click Create organization.
If someone already invited you, click See invitations instead of creating a new organization.

Create your organization. The name cannot include spaces.

3

Connect your AWS account

Next, link the AWS account where Gapstack should provision resources. See Connect an AWS account for the full walkthrough.
  1. Click Connect a new account.
  2. Enter an Account name you will recognize, such as Dev.
  3. Click Open AWS Authorization Page. Do not change anything on the CloudFormation stack.
  4. Select I acknowledge that AWS CloudFormation might create IAM resources with custom names.
  5. Click Create stack.
  6. Wait a few minutes, then open Organization settings and refresh until the status is Connected.
You must have AdministratorAccess (recommended) or be the root user (not recommended) to create the stack.
4

Connect GitHub

Connect GitHub so Gapstack can deploy your artifacts, including Lambda code.
  1. Click Connect to GitHub.
  2. Authorize the Gapstack GitHub App for the account or organization that owns your repositories.

Connect GitHub so you can deploy artifacts such as Lambda code.

5

Create your first project

After AWS and GitHub are connected, Gapstack opens the dashboard. The sidebar lists Dashboard, Projects, Environments, Resources, and Workflows.
  1. Click + Create a New Project at the top of the sidebar.
  2. Name the project and save it.
A project only groups environments. It does not create a CloudFormation stack. You add environments under the project. Each environment can target its own AWS account or us-* region, and that is when Gapstack provisions resources.

Click + Create a New Project on the dashboard.

You have an organization, a linked AWS account, GitHub connected, and a project on the dashboard.

​
Next steps

Connect an AWS account

Create the CloudFormation stack and confirm the account shows as Connected.

Deploy an artifact to S3

Add the GitHub Actions steps that upload Lambda artifacts to the environment S3 bucket.

API overview

Call the same workflow from the API: tenants, projects, environments, and AWS accounts.