Documentation

Minimal docs to get the TanStack Start starter running.

What this is

tanstarter/ is the product: a TanStack Start + React starter with auth, Postgres, and optional billing/AI/storage integrations.

Start here

  • Quickstart: run locally in ~10 minutes
  • TanStarter: what’s included and where to edit
  • Authentication: Google OAuth-first auth (+ optional magic links)
  • Database: Postgres + Drizzle schema + migrations
  • Payments: Stripe (default) or Polar (optional)
  • Deployment: build output + production env + webhooks

What you need

Required to run the full starter as-is:

  • Bun (recommended) + Node 18+
  • PostgreSQL (DATABASE_URL)
  • Resend (magic links + email verification)
  • Optional integrations: Stripe, Polar, Supabase Storage, OpenAI

If you want to explore optional modules:

Feature Flags

  • Environment-based feature toggles
  • A/B testing capabilities
  • Gradual feature rollouts
  • Subscription-based feature gating

πŸ“š Advanced Topics

API Development

  • RESTful API design
  • Authentication middleware
  • Rate limiting and throttling
  • API documentation

Database Optimization

  • Query optimization
  • Indexing strategies
  • Connection pooling
  • Migration management

Performance Tuning

  • Code splitting and lazy loading
  • Image optimization
  • Caching strategies
  • CDN configuration

Scaling Strategies

  • Horizontal scaling
  • Database sharding
  • Load balancing
  • Microservices architecture

πŸ†˜ Support & Resources

Getting Help

  • Documentation: Comprehensive guides and API references
  • GitHub Issues: Bug reports and feature requests
  • Discord Community: Real-time help and discussions
  • Email Support: Direct assistance for licensing and custom development

Resources

  • Example Applications: Reference implementations
  • Video Tutorials: Step-by-step setup guides
  • API Playground: Interactive API testing
  • Code Examples: Reusable code snippets

πŸ“ Contributing

We welcome contributions to improve the documentation and codebase:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Documentation Standards

  • Clear, concise explanations
  • Code examples with comments
  • Step-by-step instructions
  • Troubleshooting sections
  • Cross-references to related topics

Important License Note

This kit is intended for your own projects (personal / your own SaaS). Client projects are not allowed unless you have a custom license.

Ready to build something amazing? Start with the Quickstart Guide.