README.md

Authentication Documentation

Quick reference guides for FlowStack authentication setup using Better Auth and @daveyplate/better-auth-ui.

---

📋 Guides by Skill Level

🟢 Beginner

Start here if you're new to FlowStack auth:

Guide	Time	Description
Auth Modes	⏱️ 10 min	Switch between simple and organization auth
Protected Routes	⏱️ 5 min	Protect pages requiring authentication
Configuration	⏱️ 10 min	Centralized config reference

🟡 Intermediate

For developers building real features:

Guide	Time	Description
Onboarding	⏱️ 20 min	Multi-step onboarding system
Email Verification Policy	⏱️ 10 min	Force redirect or banner for unverified users
Organization Invitations	⏱️ 15 min	Team invite flows
Adding Providers	⏱️ 10 min	Add OAuth providers (GitHub, etc.)
OAuth Redirects	⏱️ 10 min	Handle social login redirects
Email Templates	⏱️ 10 min	Customize auth emails

🔴 Advanced

Deep customization for complex requirements:

Guide	Time	Description
User Metadata	⏱️ 15 min	Custom fields on user signup
Cross-Domain Auth	⏱️ 20 min	Multi-subdomain login

🆘 Help

Guide	Description
Troubleshooting	Common issues and solutions

---

📁 Key Files Overview

Configuration Files

File	Purpose
apps/*/src/config/urls.ts	Frontend/API URLs (APP_URLS)
apps/*/src/config/redirects.ts	Frontend redirect paths
packages/auth/src/config/redirects.ts	Backend redirect paths

Backend (packages/auth/)

File	Purpose
src/auth.ts	Main Better Auth configuration
src/email/*.ts	Email sending functions
src/types.ts	Environment variable types

Frontend (apps/web/ or apps/tanstack/)

File	Purpose
src/lib/auth-client.ts	Auth client configuration
src/providers.tsx	AuthUIProvider setup
src/pages/auth/*.tsx	Auth page components

---

🔗 External References

• 📚 Better Auth Docs
• 🔧 OAuth Concepts
• 🔧 Social Providers Options

---

👉 Getting Started

New to FlowStack? Start with our Quick Start Guide.