Bubbles
  • English

      • Quick Start

      Getting started with BubblesJS is easy! Let's create your first project.

      Environment Requirements

      • Node.js >= 18.0.0
      • Package manager: npm, yarn, pnpm, or bun

      Create Project

      You can use create-bubbles to create a new BubblesJS project:

      npm
      yarn
      pnpm
      bun
      npm create bubbles@latest my-project

      Choose Template

      During project creation, you'll be prompted to select a template:

      • vue-vite-eslint: Vue 3, Vite, ESLint, Pinia, Ant Design Vue Next
      • react-rsbuild-biome: React 19, Rsbuild, Biome, Ant Design
      • vp-react: React starter powered by Vite+
      • vp-react-shadcn: Vite+ React starter with shadcn and Tailwind CSS
      • vp-monorepo-react-nestjs: Vite+ monorepo starter
      • taro-vue-eslint: Taro 4.2 and Vue 3.5 for mini-programs and H5
      • nextjs-vinext-eslint: Next.js 16 and React 19 with Vinext

      Start Development

      After project creation, navigate to your project directory and start the development server:

      cd my-project
      npm
      yarn
      pnpm
      bun
      # Install dependencies
npm install

# Start development server
npm run dev

      Project Structure

      The generated structure depends on the selected template. Single-app templates usually include src/, public/, package.json, and a build config such as vite.config.ts or rsbuild.config.ts; monorepo templates include apps/, packages/, and pnpm-workspace.yaml.

      Next Steps

      Happy coding! 🚀