Skip to content

sj-distributor/create-react-boilerplates

Repository files navigation

🚀 Create React Boilerplates

npm version MIT License node CI Test

一个快速创建现代化 React 项目的脚手架工具,提供多种预配置模板,让你能够快速启动 React 项目开发。

✨ 特性

  • 🚀 快速创建 - 一条命令即可创建完整的 React 项目
  • 📦 多种模板 - 提供不同技术栈的项目模板
  • 🔧 开箱即用 - 预配置了 TypeScript、ESLint、Vite 等现代化工具
  • 🎯 最佳实践 - 遵循 React 社区最佳实践和代码规范
  • 📱 现代化 - 使用最新版本的 React 19 和相关依赖

📋 系统要求

  • npm / yarn / pnpm

🚀 快速开始

使用 yarn

yarn create react-boilerplates

使用 pnpm

pnpm create react-boilerplates

📚 可用模板

1. TypeScript 模板 (react-ts)

基础的 React + TypeScript 项目模板,包含:

  • ⚛️ React 19
  • 🔷 TypeScript
  • ⚡ Vite 构建工具
  • 🔍 ESLint 代码检查
  • 🎨 现代化项目结构

2. TypeScript + Zustand 模板 (react-zustand)

包含状态管理的完整项目模板,包含:

  • ⚛️ React 19
  • 🔷 TypeScript
  • 🐻 Zustand 状态管理
  • 🛠️ Ramda 函数式编程工具库
  • ⚡ Vite 构建工具
  • 🔍 ESLint 代码检查

🛠️ 使用方式

  1. 创建项目

    pnpm create react-boilerplates
  2. 选择模板

    运行命令后,会出现交互式选择界面:

    • 输入项目名称
    • 选择项目模板
    • 确认包名称(如果需要)
  3. 安装依赖并启动

    cd <your-project-name>
    pnpm install
    pnpm dev

🤝 贡献

欢迎提交 Issue 和 Pull Request!

  1. Fork 本仓库
  2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交你的更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 打开一个 Pull Request

📄 许可证

本项目基于 MIT 许可证开源。

🔗 相关链接

📝 更新日志

查看 Releases 了解版本更新信息。