TinyShip
TinyShip
TinyShip
TinyShip
TinyShip Documentation
TinyShip User GuideGetting StartedBasic Configuration
Credits System Configuration
Storage Service ConfigurationCaptcha Configuration
Development Best PracticesLocal E2E Workflow
User Guide

Development Best Practices

Recommended workflow and collaboration practices for TinyShip

Framework Selection

  • Next.js (apps/next-app/): best for enterprise features, SEO, and complex SSR
  • Nuxt.js (apps/nuxt-app/): best for Vue teams and rapid iteration
  • TanStack Start (apps/tanstack-app/): best for lightweight React full-stack development

Git Workflow

  • Use topic branches: feature/*, fix/*, docs/*
  • Use semantic commits: feat:, fix:, docs:
  • Sync upstream template updates regularly and resolve conflicts early

Customization Guidance

  • Prefer adding new modules/endpoints over modifying template core behavior
  • Keep business logic decoupled from template core for easier upgrades

Traditional Deployment

Traditional deployment on VPS servers

Local E2E Workflow

Run Playwright E2E locally across Next.js, Nuxt.js, and TanStack Start

On this page

Framework SelectionGit WorkflowCustomization Guidance