Next.js Template for Fly.io

This is a Next.js template that's configured for easy deployment on Fly.io. It's bootstrapped with create-next-app, and includes the following:

Config for standalone builds (this keeps your Docker image as small as possible)
Github Action workflow for auto-deploys when main branch is updated
Github Action workflow for spinning up review apps each time a new PR is made

The template also includes the default options offered by create-next-app:

Getting Started Locally

To use this template, run the following command:

npx create-next-app@latest --example https://github.com/anniebabannie/fly-nextjs-template <your-app-name>

To run the app locally, start the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

To take advantage of the Github Actions included in this template, generate a Fly.io auth token using flyctl:

# obtain the Fly API token
fly auth token

# set the repository secret in GitHub
gh secret set FLY_API_TOKEN=<your-token>

If you don't have the GitHub CLI installed, you can also set the repository secret through the Settings tab on your repo.

First, launch your app to Fly.io by running the following command:

fly launch

This will generate a Dockerfile and a fly.toml for you. You can update the name of your Fly application in the fly.toml to whatever you like.

Next, you can make your first deploy in one of two ways:

Run fly deploy
If you've added your FLY_API_TOKEN as a repository secret in Github, you can git push origin main, and the auto-deploy Github action will deploy it for you.