Getting started

Where to begin?

• The Hello World tutorial provides a quick walkthrough of the steps for setting up a project to build using Heft

• The main NPM package page is here: @rushstack/heft

• Interfacing with Rush explains how Heft and Rush interact

• The Heft architecture article provides more detail about the build system's design

Links

• CHANGELOG.md - Find out what's new in the latest version
• UPGRADING.md - Instructions for migrating existing projects to use a newer version of Heft
• API Reference

Sample projects

For a couple quick examples of Heft projects in a real Rush monorepo, take a look at these folders:

• heft-node-basic-tutorial: A basic Node.js application with Jest and ESLint

• heft-webpack-basic-tutorial: A basic web application bundled using Webpack