TinyShip User Guide
A modern, feature-complete monorepo starter kit designed for building SaaS applications
A modern monorepo starter for global SaaS apps. Google, GitHub, Stripe, and Cloudflare R2 (or S3) are the default path for gettinyship.dev. WeChat, Aliyun SMS, WeChat Pay, Alipay, and OSS are optional China providers.
Core Features
- Three Framework Support: Next.js (React), Nuxt (Vue), and TanStack Start (React)
- Authentication: Email/password, Google, and GitHub. WeChat and SMS are optional (China)
- Payments: Stripe, PayPal, Creem, and Dodo Payments. WeChat Pay and Alipay are optional (China)
- Affiliate System: Referral links, commission records, signup rewards, and withdrawal approval
- 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
AI Users: If you use Cursor, Claude Code, Codex, or other AI editors, install Agent Skills for interactive guided setup: npx skills add TinyshipCN/tinyship-skills. Then just tell your AI "help me set up TinyShip" or "all-in Cloudflare" to get started.
Configuration Guides
App name, Logo, theme system, internationalization
Email/password, Google, and GitHub. WeChat and SMS are optional (China)
Stripe, PayPal, Creem, and Dodo. WeChat Pay and Alipay are optional (China)
Credit recharge, consumption configuration, AI billing
Referral links, commission records, signup rewards, and withdrawal approval
AI chat, image generation, and video generation configuration
Cloudflare R2 or Amazon S3. Aliyun OSS is optional (China). Tencent COS is not in the current storage config
Cloudflare Turnstile bot protection
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
│ ├── tanstack-app/ # TanStack Start 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 (r2 / s3 / oss)
│ ├── ai/ # AI integration
│ ├── i18n/ # Internationalization
│ ├── permissions/ # Permission management
│ ├── react-shared/ # Shared React components (Next.js + TanStack Start)
│ ├── ui/ # Shared UI styles
│ └── validators/ # Data validation
└── docs/ # Project documentationTech Stack
| Category | Technology |
|---|---|
| Frontend | Next.js 15, Nuxt.js 3, TanStack Start, 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 |
| Affiliate Tab | /dashboard | Referral link, commission balance, and referral records | |
| Withdrawal Tab | /dashboard | Request withdrawals and view withdrawal history | |
| 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 | |
| Video Gen | /video-generate | AI video 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 | |
| Commissions | /admin/commissions | Affiliate commission records | |
| Withdrawals | /admin/withdrawals | Withdrawal request approval | |
| Pricing | /admin/pricing | Dynamic pricing plan management |