Skip to content

README.md

Latest commit

 

History

History
253 lines (179 loc) · 7.08 KB

README.md

File metadata and controls

253 lines (179 loc) · 7.08 KB

CloudBase React 模板

基于 React、Vite 和腾讯云开发（CloudBase）的现代化 Web 应用模板，为开发者提供了快速构建全栈应用的能力。

Powered by CloudBase

本项目基于 CloudBase AI ToolKit 开发，通过AI提示词和 MCP 协议+云开发，让开发更智能、更高效，支持AI生成全栈代码、一键部署至腾讯云开发（免服务器）、智能日志修复。

项目特点

  • 🚀 基于 Vite 构建，提供极速的开发体验
  • ⚛️ 使用 React 19 和 React Router 6 构建现代化 UI
  • 🎨 集成 Tailwind CSS 和 DaisyUI 组件库，快速构建漂亮的界面
  • 🔄 使用 Framer Motion 实现流畅的动画效果
  • 🎁 深度集成腾讯云开发 CloudBase，提供一站式后端云服务

项目架构

前端架构

  • 框架：React 19
  • 构建工具：Vite
  • 路由：React Router 6（使用 HashRouter）
  • 样式：Tailwind CSS + DaisyUI
  • 动画：Framer Motion

云开发资源

本项目使用了以下腾讯云开发（CloudBase）资源：

  • 身份认证：用于用户登录和身份验证
  • 云数据库：可用于存储应用数据
  • 云函数：可用于实现业务逻辑
  • 云存储：可用于存储文件
  • 静态网站托管：用于部署前端应用

开始使用

前提条件

安装依赖

npm install

配置云开发环境

  1. 打开 src/utils/cloudbase.js 文件
  2. 将 ENV_ID 变量的值修改为您的云开发环境 ID
  3. 将 vite.config.js 中的https://envId-appid.tcloudbaseapp.com/ 替换为你的云开发环境静态托管默认域名，可以使用 MCP 来查询云开发环境静态托管默认域名

本地开发

npm run dev

构建生产版本

npm run build

部署指南

部署到云开发静态网站托管

  1. 构建项目：npm run build
  2. 登录腾讯云开发控制台
  3. 进入您的环境 -> 静态网站托管
  4. 上传 dist 目录中的文件

目录结构

├── public/               # 静态资源
├── src/
│   ├── components/       # 可复用组件
│   ├── pages/            # 页面组件
│   ├── utils/            # 工具函数和云开发初始化
│   ├── App.jsx           # 应用入口
│   ├── main.jsx          # 渲染入口
│   └── index.css         # 全局样式
├── index.html            # HTML 模板
├── tailwind.config.js    # Tailwind 配置
├── postcss.config.js     # PostCSS 配置
├── vite.config.js        # Vite 配置
└── package.json          # 项目依赖

开始开发

首页位于 src/pages/HomePage.jsx，是应用的默认入口页面。您可以根据项目需求自定义首页内容。

路由系统说明

本项目使用 React Router 6 作为路由系统，并采用 HashRouter 实现路由管理，这样可以更好地兼容静态网站托管服务，避免刷新页面时出现 404 错误。

当前路由结构

<Router>
  <div className="flex flex-col min-h-screen">
    <main className="flex-grow">
      <Routes>
        <Route path="/" element={<HomePage />} />
        {/* 可以在这里添加新的路由 */}
        <Route path="*" element={<HomePage />} />
      </Routes>
    </main>
    <Footer />
  </div>
</Router>

如何添加新页面和路由

  1. 在 src/pages 目录下创建新页面组件，例如 ProductPage.jsx：
import React from 'react';

const ProductPage = () => {
  return (
    <div className="container mx-auto py-8">
      <h1 className="text-3xl font-bold mb-4">产品页面</h1>
      <p>这是产品页面的内容</p>
    </div>
  );
};

export default ProductPage;
  1. 在 App.jsx 中导入新页面并添加路由：
import ProductPage from './pages/ProductPage';

// 在 Routes 中添加新路由
<Routes>
  <Route path="/" element={<HomePage />} />
  <Route path="/products" element={<ProductPage />} />
  <Route path="*" element={<HomePage />} />
</Routes>
  1. 使用 Link 组件在页面中添加导航链接：
import { Link } from 'react-router-dom';

// 在页面中添加链接
<Link to="/products" className="btn btn-primary">前往产品页面</Link>

使用路由参数

对于需要动态参数的路由，可以使用参数路径：

// 在 App.jsx 中定义带参数的路由
<Route path="/product/:id" element={<ProductDetailPage />} />

// 在 ProductDetailPage.jsx 中获取参数
import { useParams } from 'react-router-dom';

const ProductDetailPage = () => {
  const { id } = useParams();
  
  return (
    <div className="container mx-auto py-8">
      <h1 className="text-3xl font-bold mb-4">产品详情</h1>
      <p>产品ID: {id}</p>
    </div>
  );
};

路由导航

除了使用 <Link> 组件，还可以使用编程式导航：

import { useNavigate } from 'react-router-dom';

const ComponentWithNavigation = () => {
  const navigate = useNavigate();
  
  const handleClick = () => {
    navigate('/products');
    // 或者带参数: navigate('/product/123');
    // 或者返回上一页: navigate(-1);
  };
  
  return (
    <button onClick={handleClick} className="btn btn-primary">
      前往产品页面
    </button>
  );
};

云开发功能说明

初始化云开发

本模板在 src/utils/cloudbase.js 中集中管理云开发的初始化和匿名登录功能。这个工具文件提供了云开发示例的获取/登录，调用云函数，云存储，云数据库等能力。

使用云数据库、云函数、云存储

通过 src/utils/cloudbase.js 访问云开发服务：

import { app, checkLogin } from '../utils/cloudbase';

// 数据库操作
await checkLogin();
const db = app.database();
const result = await db.collection('users').get(); // 查询数据
await db.collection('users').add({ name: 'test' }); // 添加数据
// 调用云函数
const funcResult = await app.callFunction({ name: 'getEnvInfo' });
// 文件上传
const uploadResult = await app.uploadFile({ cloudPath: 'test.jpg', filePath: file });
// 数据模型
const models = app.models;

重要说明

  1. 在使用前请先在 src/utils/cloudbase.js 文件中将 ENV_ID 变量的值修改为您的云开发环境 ID。
  2. 本模板默认使用Publishable Key 进行资源访问，这适合快速开发和测试，但在生产环境中可能需要更严格的身份验证。
  3. 所有云开发功能都通过初始化的应用实例直接调用，无需二次封装。
  4. checkLogin 方法会检查当前登录状态，如果已登录则返回当前登录状态。
  5. 在使用数据库、云函数、云存储等功能前，请确保在云开发控制台中已创建相应的资源。

贡献指南

欢迎贡献代码、报告问题或提出改进建议！

许可证

MIT