> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amplify.security/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Onboard your projects to Amplify in under 5 minutes.

export const amplify = {
  app_url: "https://app.amplify.security"
};

## Overview

We're going to walk you through the steps to onboard your projects to Amplify.
The onboarding process is designed to be fully guided, so if you'd rather just follow along in the <a href={amplify.app_url}>Amplify App</a> and skip this guide, you can do that too.

### What to expect

During onboarding you will:

1. Install the Amplify GitHub App.
2. Select which projects you want to onboard.
3. Approve the Pull Requests that Amplify will open for you in selected projects. These Pull Requests
   add the Amplify Security GitHub Actions Workflow.

<Warning>
  You will need permission to install a GitHub App for the organization you wish to secure with Amplify in order to complete this Quickstart guide.
</Warning>

## Quickstart

### Sign Up

To get started, navigate to the Amplify App at <a href={amplify.app_url}>{amplify.app_url}</a> or by
using the Sign In button in the top right corner of this page.

<img className="block dark:hidden" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-light.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=2ac6a51f4194225f8573af36a0ad65c9" alt="Sign Up" data-path="images/signup-light.png" />

<img className="hidden dark:block" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-dark.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=e3606b70906517d1480115eed4ec82fc" alt="Sign Up" data-path="images/signup-dark.png" />

Select *Sign Up* to continue.

<img className="block dark:hidden" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-providers-light.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=f83ecc5f444f4257b4110c1a17d3d5e9" alt="Sign Up Providers" data-path="images/signup-providers-light.png" />

<img className="hidden dark:block" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-providers-dark.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=c0c3944562d31f3de661e34e4dc782fd" alt="Sign Up Providers" data-path="images/signup-providers-dark.png" />

Select *Sign up with GitHub* to continue.

<Tip>Support for GitLab and Bitbucket is coming soon!</Tip>

### Authenticate with the Amplify GitHub App

You will be redirected to GitHub to authenticate using the Amplify GitHub App.

<img className="block dark:hidden" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-github-oauth-light.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=f04c0a05f0a2281d020845a593c54071" alt="GitHub OAuth" data-path="images/signup-github-oauth-light.png" />

<img className="hidden dark:block" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-github-oauth-dark.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=058e383e88dd367386958f49bb6683bf" alt="GitHub OAuth" data-path="images/signup-github-oauth-dark.png" />

Select *Authorize Amplify* to continue.

### Install the Amplify GitHub App

Once authenticated, you must install the Amplify GitHub App in the GitHub organization you want
to secure with Amplify.

<img className="block dark:hidden" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-org-light.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=3023fa8234f7b2b2d7707f6739723fba" alt="Install App" data-path="images/signup-org-light.png" />

<img className="hidden dark:block" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-org-dark.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=4ae4dc3b067a4e1b62040bc4356773af" alt="Install App" data-path="images/signup-org-dark.png" />

Select *Redirect to GitHub to allow access to your organization* to continue. You will be redirected
to GitHub. Install the GitHub Amplify App in the organization you want to secure. After installation,
you will be redirected back to Amplify to continue the onboarding process.

### Accept terms & conditions

You must accept the terms and conditions of the beta agreement to continue.

<img className="block dark:hidden" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-eula-light.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=605e0e0ba82fef5cab37d76c0ac97dbe" alt="Terms and Conditions" data-path="images/signup-eula-light.png" />

<img className="hidden dark:block" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-eula-dark.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=07e603749f6f08ea8801fa667b578ce5" alt="Terms and Conditions" data-path="images/signup-eula-dark.png" />

### Select projects to secure

After authenticating with the Amplify GitHub App, you will be redirected back to the Amplify App
to choose which projects you want to secure with Amplify.

<img className="block dark:hidden" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-projects-light.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=6da077c181cf58000a09576ceb74bba8" alt="Select Projects" data-path="images/signup-projects-light.png" />

<img className="hidden dark:block" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-projects-dark.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=5a05343772f5c1688cc721f6e2e4fed3" alt="Select Projects" data-path="images/signup-projects-dark.png" />

Select all projects you would like to secure with Amplify and select *Next*.

### Select security tools to run

You will now be prompted to choose which security tools Amplify will run when scanning your projects.

<img className="block dark:hidden" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-tools-light.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=63820cf3acb48a1ea4e021724d88752f" alt="Select Tools" data-path="images/signup-tools-light.png" />

<img className="hidden dark:block" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-tools-dark.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=5e0101866eb4fb22d9d9a7fb885a37d0" alt="Select Tools" data-path="images/signup-tools-dark.png" />

Select *Open Installation PRs* to continue.

### Approve installation PRs

Amplify will now open Pull Requests in the selected projects to add the Amplify Security
GitHub Actions workflow. You will need to approve these PRs to enable Amplify scanning in
your projects.

<img className="block dark:hidden" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-prs-light.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=1f4b1b99c786ee4d4c7382681189f72d" alt="Approve PRs" data-path="images/signup-prs-light.png" />

<img className="hidden dark:block" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-prs-dark.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=20ebfac678696931fb94968bd0942cdd" alt="Approve PRs" data-path="images/signup-prs-dark.png" />

The Amplify App will automatically reflect the status of the PRs as they are merged.

<img className="block dark:hidden" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-prs-merged-light.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=b117a6d8d13c12b6fe069d1140560c60" alt="Merged PRs" data-path="images/signup-prs-merged-light.png" />

<img className="hidden dark:block" width="400" src="https://mintcdn.com/amplifysecurity/yM-znr0cSZulx4YZ/images/signup-prs-merged-dark.png?fit=max&auto=format&n=yM-znr0cSZulx4YZ&q=85&s=602b9c6af1dee949fbad2f6099cef3e5" alt="Merged PRs" data-path="images/signup-prs-merged-dark.png" />

Select *Finish* to complete the onboarding process.