Skip to content

Installation ​

How to install dependencies and structure your app.

Automatic Installation ​

1.
Install bounce-cli globally to use the CLI commands:
bash
npm install -g bounce-cli
bash
yarn add -g bounce-cli
bash
pnpm add -g bounce-cli
bash
bun add -g bounce-cli
2.
Then run the init command to set up your project:
bash
npx bounce init
bash
yarn dlx bounceui init
bash
pnpm dlx bounceui init
bash
bun dlx bounceui init
3.
You will be prompted to configure your project:
bash
? What is your project name? my-project
? What is your project description? A sample Bounce UI project
4.
Once our project is ready to develop, you can add individual components using the add command:
bash
npx bounce add button
bash
yarn bounce add button
bash
pnpm bounce add button
bash
bun bounce add button
5.
Or you can add all components at once:
bash
npx bounce add --all
bash
yarn bounce add --all
bash
pnpm bounce add --all
bash
bun bounce add --all

Manual Installation ​

1.
To install BounceUI, run one of the following commands in your terminal:
bash
npm install @bounceui/react
bash
yarn add @bounceui/react
bash
pnpm add @bounceui/react
bash
bun add @bounceui/react
2.
BounceUI is built on top of Tailwind CSS, so you need to install Tailwind CSS first. You can follow the official installation guide to install Tailwind CSS.