Brunch

Brunch ↗ is a fast front-end web application build tool with simple declarative configuration and seamless incremental compilation for rapid development.

Install Brunch

To begin, install Brunch:

npm install -g brunch

Create a Brunch project

Brunch maintains a library of community-provided skeletons ↗ to offer you a boilerplate for your project. Run Brunch's recommended es6 skeleton with the brunch new command:

brunch new proj -s es6

Before you continue

All of the framework guides assume you already have a fundamental understanding of Git ↗. If you are new to Git, refer to this summarized Git handbook ↗ on how to set up Git on your local machine.

If you clone with SSH, you must generate SSH keys ↗ on each computer you use to push or pull from GitHub.

Refer to the GitHub documentation ↗ and Git documentation ↗ for more information.

Create a GitHub repository

Create a new GitHub repository by visiting repo.new ↗. After creating a new repository, go to your newly created project directory to prepare and push your local application to GitHub by running the following commands in your terminal:

git init
git remote add origin https://github.com/<your-gh-username>/<repository-name>
git add .
git commit -m "Initial commit"
git branch -M main
git push -u origin main

Deploy with Cloudflare Pages

To deploy your site to Pages:

Log in to the Cloudflare dashboard ↗ and select your account.
In Account Home, select Workers & Pages > Create application > Pages > Connect to Git.
Select the new GitHub repository that you created and, in the Set up builds and deployments section, select Brunch as your Framework preset. Your selection will provide the following information.

Configuration option	Value
Production branch	`main`
Build command	`npx brunch build --production`
Build directory	`public`

For the complete guide to deploying your first site to Cloudflare Pages, refer to the Get started guide.

After deploying your site, you will receive a unique subdomain for your project on *.pages.dev.

Every time you commit new code to your Brunch site, Cloudflare Pages will automatically rebuild your project and deploy it. You will also get access to preview deployments on new pull requests and be able to preview how changes look to your site before deploying them to production.

Learn more

By completing this guide, you have successfully deployed your Brunch site to Cloudflare Pages. To get started with other frameworks, refer to the list of Framework guides.

Was this helpful?

Cloudflare Dashboard Discord Community Learning Center Support Portal