Installation

Learn how to install and set up BuilderKit in your Angular project.

Before you start

This guide assumes you are already familiar with installing Angular and have your development environment ready. You should have Node.js installed and the Angular CLI set up before continuing.

When you purchase a BuilderKit license, you will be able to request access to the private @builderkit/builderkit repository containing the source code.

The BuilderKit repository has a collection of files and folders so it's NOT something you can clone and use directly.

The only way to use BuilderKit is to start with the Spark starter template. This is a fully functional Angular project with TailwindCSS and BuilderKit already set up and configured. You can find it in the templates/spark folder.

The BuilderKit repository includes a starter template called Spark located in the templates/spark folder. This is a fully functional Angular project with TailwindCSS and BuilderKit already set up and configured.

You can use this starter template as a base for your new project. Simply clone the repository, copy the templates/spark folder to a new location, and rename it to match your project name.

Then follow the steps below to install dependencies and start the development server.

01. Install dependencies

The package.json does not use caret or tilde symbols, which means all dependencies are locked to exact versions. This helps ensure maximum compatibility between Angular and BuilderKit features, avoiding unexpected updates or mismatches.

While you are free to use any package manager, npm is preferred for consistency with the lock file:

npm install

02. Start the development server

Run the Angular development server with:

ng serve

The application will be available at http://localhost:4200/.

03. Begin development

You can now start building your application. The design tokens, theming, and paths are already configured. BuilderKit is ready for you to extend and customize based on your specific needs.