User Guide
TinyShip User Guide
A modern, feature-complete monorepo starter kit designed for building SaaS applications
A modern, feature-complete monorepo starter kit designed for building SaaS applications, supporting both domestic and international markets.
Core Features
- Dual Framework Support: Supports both Next.js (React) and Nuxt.js (Vue)
- Complete Authentication: Email/password, OAuth (Google, GitHub, WeChat), SMS login
- Multiple Payment Integration: Stripe, WeChat Pay, CREEM
- Internationalization: Built-in multi-language system
- RBAC Permission Management: Role-based access control
- AI Integration: Support for multiple AI providers
- Type Safety: Comprehensive TypeScript support
- Modern UI: Component library based on shadcn/ui
Quick Start
Configuration Guides
Basic Configuration
App name, Logo, theme system, internationalization
Authentication
Email/password, Google, GitHub, WeChat, SMS login
Payment Configuration
Stripe, WeChat Pay, Creem integration guides
Credits System
Credit recharge, consumption configuration, AI billing
AI Features
AI chat, image generation configuration
Storage Service
Alibaba Cloud OSS, AWS S3, Cloudflare R2
Captcha
Cloudflare Turnstile bot protection
Deployment
Vercel, Docker, VPS deployment guides
Project Architecture
Monorepo Structure
TinyShip uses a simplified monorepo structure with shared core code in the libs directory:
tinyship/
├── apps/ # Application implementations
│ ├── next-app/ # Next.js application
│ ├── nuxt-app/ # Nuxt.js application
│ └── docs-app/ # Documentation site (Fumadocs)
├── libs/ # Core libraries
│ ├── database/ # Database operations and schema
│ ├── auth/ # Authentication service
│ ├── email/ # Email service
│ ├── sms/ # SMS service
│ ├── payment/ # Payment service
│ ├── storage/ # Storage service (OSS/S3/R2)
│ ├── ai/ # AI integration
│ ├── i18n/ # Internationalization
│ ├── permissions/ # Permission management
│ ├── ui/ # Shared UI components
│ └── validators/ # Data validation
└── docs/ # Project documentationTech Stack
| Category | Technology |
|---|---|
| Frontend | Next.js 15, Nuxt.js 3, TypeScript, Tailwind CSS |
| Backend | Drizzle ORM, PostgreSQL, Better Auth |
| Deployment | Vercel, Netlify, Docker, PNPM |
Application Pages Overview
After starting the application, here are the main page paths:
| Category | Page | Path | Description |
|---|---|---|---|
| Home | Home | / | Application homepage |
| Auth | Sign In | /signin | User login |
| Sign Up | /signup | User registration | |
| Phone Login | /cellphone | Phone verification login | |
| WeChat Login | /wechat | WeChat scan login | |
| User | Dashboard | /dashboard | User personal center |
| Premium | /premium-features | Premium features demo | |
| Payment | Pricing | /pricing | View subscription plans |
| AI | AI Chat | /ai | AI chat feature |
| Image Gen | /image-generate | AI image generation | |
| Storage | Upload Demo | /upload | File upload demo |
| Admin | Admin Panel | /admin | Admin dashboard |
| User Management | /admin/users | User list and management | |
| Order Management | /admin/orders | Order list and management | |
| Subscription | /admin/subscriptions | Subscription management | |
| Credits | /admin/credits | Credit transaction records |