Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(static-deploy): add deployment instructions for AWS with Flightcontrol #12067

Closed
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions docs/guide/static-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,3 +315,60 @@ You can deploy your Vite app as a Static Site on [Render](https://render.com/).
By default, any new commit pushed to the specified branch will automatically trigger a new deployment. [Auto-Deploy](https://render.com/docs/deploys#toggling-auto-deploy-for-a-service) can be configured in the project settings.

You can also add a [custom domain](https://render.com/docs/custom-domains) to your project.

## AWS via Flightcontrol

### Set Up your Flightcontrol account

On a high-level, the steps you'll need to follow in order to deploy a project for the first time are:

1. Create an account at [Flightcontrol](https://app.flightcontrol.dev/signup)
2. Create an account at [AWS](https://portal.aws.amazon.com/billing/signup) (if you don't already have one)
3. Link your AWS account to Flightcontrol
4. Authorize the Flightcontrol Github App to access your chosen repositories, public or private.
5. Create a Flightcontrol project with configuration via the Dashboard or with configuration via `flightcontrol.json`.

### Create a Project with Configuration via the Dashboard

1. Create a Flightcontrol project from our Dashboard. Select a repository for the source.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Create a Flightcontrol project from our Dashboard. Select a repository for the source.
1. Create a Flightcontrol project from the Dashboard. Select a repository for the source.

2. Select the `GUI` Config Type.
3. Add a static site service by clicking the `Add a Static Site`.
4. Add a build command, `yarn build` and select `Single Page App` option.
5. Add any environment variables your project might need.
6. Create your project.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
6. Create your project.
6. Submit the new project form.


### Create a Project with Configuration via "flightcontrol.json"

1. Create a Flightcontrol project from your dashboard. Select a repository for the source.
2. Select the `flightcontrol.json` Config Type.
3. Add a new file at the root of your repository called `flightcontrol.json`. Here's an example configuration that creates a static site service for your vite app:

```json
{
"$schema": "https://app.flightcontrol.dev/schema.json",
"environments": [
{
"id": "production",
"name": "Production",
"region": "us-west-2",
"source": {
"branch": "main"
},
"services": [
{
"id": "my-static-vite",
"buildType": "nixpacks",
"name": "My static vite site",
"type": "static",
"domain": "www.yourdomain.com",
"buildCommand": "yarn build",
"outputDirectory": "public",
"singlePageApp": true
}
]
}
]
}
```

4. Create your project.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Create your project.
4. Submit the new project form.