用户指南
TinyShip 用户指南
一个现代化的、功能完备的 monorepo 起始套件,专为构建 SaaS 应用设计
一个现代化的、功能完备的 monorepo 起始套件,专为构建 SaaS 应用设计,同时支持国内和国际市场。
核心特性
- 双框架支持:同时支持 Next.js (React) 和 Nuxt.js (Vue),开发者可根据偏好选择
- 完整的身份认证:支持邮箱密码、OAuth(Google、GitHub、微信)、手机短信登录
- 多种支付集成:支持 Stripe、微信支付、CREEM 等主流支付平台
- 国际化支持:内置多语言系统,轻松支持全球市场
- RBAC 权限管理:基于角色的访问控制,灵活的权限体系
- AI 功能集成:支持多种 AI 提供商,快速构建智能应用
- 类型安全:全面的 TypeScript 支持和数据验证
- 现代化 UI:基于 shadcn/ui 的组件库,支持多主题切换
快速开始
配置指南
基础配置
应用名称、Logo、主题系统、国际化配置
身份认证
邮箱密码、Google、GitHub、微信、短信登录
支付配置
Stripe、微信支付、Creem 配置指南
积分系统
积分充值、消耗配置、AI 积分计费
AI 功能
AI 对话、图片生成配置
存储服务
阿里云 OSS、AWS S3、Cloudflare R2
验证码
Cloudflare Turnstile 人机验证
应用部署
Vercel、Docker、VPS 部署指南
项目架构
Monorepo 结构
TinyShip 采用简化的 monorepo 结构,使用 libs 目录共享核心代码:
tinyship/
├── apps/ # 应用实现
│ ├── next-app/ # Next.js 应用
│ ├── nuxt-app/ # Nuxt.js 应用
│ └── docs-app/ # 文档站点 (Fumadocs)
├── libs/ # 核心库
│ ├── database/ # 数据库操作和架构
│ ├── auth/ # 身份认证服务
│ ├── email/ # 邮件服务
│ ├── sms/ # 短信服务
│ ├── payment/ # 支付服务
│ ├── storage/ # 存储服务(OSS/S3/R2)
│ ├── ai/ # AI 集成
│ ├── i18n/ # 国际化
│ ├── permissions/ # 权限管理
│ ├── ui/ # 共享 UI 组件
│ └── validators/ # 数据验证
└── docs/ # 项目文档技术栈
| 分类 | 技术 |
|---|---|
| 前端框架 | Next.js 15, Nuxt.js 3, TypeScript, Tailwind CSS |
| 后端服务 | Drizzle ORM, PostgreSQL, Better Auth |
| 部署工具 | Vercel, Netlify, Docker, PNPM |
应用页面总览
启动应用后,以下是主要的页面路径:
| 分类 | 页面 | 路径 | 说明 |
|---|---|---|---|
| 首页 | 首页 | / | 应用首页 |
| 认证 | 登录 | /signin | 用户登录 |
| 注册 | /signup | 用户注册 | |
| 手机登录 | /cellphone | 手机验证码登录 | |
| 微信登录 | /wechat | 微信扫码登录 | |
| 用户 | 仪表盘 | /dashboard | 用户个人中心 |
| 高级功能 | /premium-features | 付费功能示例 | |
| 支付 | 定价页 | /pricing | 查看订阅计划和积分包 |
| AI | AI 对话 | /ai | AI 聊天功能 |
| 图片生成 | /image-generate | AI 图片生成 | |
| 存储 | 上传示例 | /upload | 文件上传示例 |
| 管理 | 管理后台 | /admin | 管理员仪表盘 |
| 用户管理 | /admin/users | 用户列表和管理 | |
| 订单管理 | /admin/orders | 订单列表和管理 | |
| 订阅管理 | /admin/subscriptions | 订阅列表和管理 | |
| 积分管理 | /admin/credits | 积分交易记录 |