Skip to content

asg5704/template-rsbuild-react-ts-heroui

Repository files navigation

RSBuild & HeroUI Template

This is a template for creating applications using RSBuild and HeroUI (v2).

🚀 Technologies used

📦 Getting Started

Prerequisites

  • Node.js (version 18 or higher)
  • npm, yarn, or pnpm

Installation

  1. To clone the project, run the following command
git clone https://github.com/asg5704/template-rsbuild-react-ts-heroui.git
cd template-rsbuild-react-ts-heroui
  1. Install dependencies

You can use one of the following to install dependencies

# npm
npm install
# pnpm
pnpm install
# or yarn
yarn install
  1. Start the development server:
# npm
npm run dev
# pnpm
pnpm run dev
# or yarn
yarn dev

The application will open automatically at http://localhost:3333

🛠️ Available Scripts

Commands Description
npm run dev Start development server with hot reload
npm run build Build for production
npm run preview Preview the production build

🏗️ Project Structure

src/
├── App.tsx          # Main application component
├── App.css          # Application styles
├── index.tsx        # Application entry point
└── env.d.ts         # TypeScript environment declarations

🎨 Styling

This template uses:

  • HeroUI Theme for consistent design tokens
  • TailwindCSS for utility-first styling
  • Custom CSS for additional styling needs

📄 License

This project is open source and available under the MIT License.

About

A RSBuild template pre-configured with HeroUI (v2) and TailwindCSS (v4)

Topics

Resources

License

Stars

Watchers

Forks