Complete documentation for the ShipSafe SaaS boilerplate - a security-first Next.js boilerplate with Firebase, Stripe, and comprehensive security features.

🚀 Quick Start

New to ShipSafe? Start here:

  1. Installation & Setup - Get up and running in minutes
  2. First Steps - Learn the basics and run your first app
  3. Ship in 5 Minutes - Build a complete landing page quickly
  4. Configuration - Customize your app settings

📚 Documentation Sections

🎯 Get Started

Essential guides to get you up and running:

Perfect for: First-time users, quick setup, understanding the architecture

🎓 Tutorials

Step-by-step guides to build features:

Perfect for: Learning by doing, building features, understanding patterns

⚙️ Features

Comprehensive feature documentation:

Core Features:

Setup Guides:

Advanced Features:

Integration Features:

Perfect for: Understanding features, setup instructions, integration guides

🧩 Components

Complete component reference:

UI Components:

Template Components:

Form Components:

Perfect for: Component usage, customization, building pages

🔒 Security

Security architecture and best practices:

Perfect for: Understanding security, implementing best practices, production hardening

🚀 Deployment

Deploy to production:

Perfect for: Going live, production setup, monitoring

🎨 Extras

Additional guides and resources:

Perfect for: Customization, AI-assisted development, troubleshooting, finding resources

🔗 Quick Links

Essential Setup

Popular Tutorials

Security & Deployment

📖 Documentation Structure

The documentation is organized into clear, logical sections for easy navigation:

🚀 Get Started

Path: docs/get-started/

Essential guides for setup, installation, and first steps. Perfect for new users.

Includes:

  • Installation guide
  • First steps walkthrough
  • Project structure overview
  • Configuration guide

🎓 Tutorials

Path: docs/tutorials/

Step-by-step guides to build features and learn by doing.

Includes:

  • Ship in 5 minutes
  • Static pages
  • Authentication
  • API routes
  • Protected pages
  • Stripe subscriptions
  • Custom components
  • Database queries
  • Real-time listeners

⚙️ Features

Path: docs/features/

Comprehensive documentation for all ShipSafe features and integrations.

Includes:

  • Authentication
  • Billing & payments
  • Database
  • Email
  • Security features
  • Firebase setup
  • Stripe setup
  • Environment variables
  • API routes
  • Webhooks
  • SEO
  • Real-time sync
  • Error handling
  • Validation

🧩 Components

Path: docs/components/

Complete reference for all UI components, templates, and forms.

Structure:

  • ui/ - Reusable UI components (Button, Input, Card, Badge, Modal, etc.)
  • templates/ - Page-level components (Header, Hero, Pricing, Footer, etc.)
  • forms/ - Form components with validation

🔒 Security

Path: docs/security/

Security architecture, best practices, and implementation guides.

Includes:

  • Security overview
  • Middleware security architecture
  • Authentication security
  • API security
  • Rate limiting
  • CSRF protection
  • Security headers
  • Tech stack reasoning

🚢 Deployment

Path: docs/deployment/

Deployment guides, checklists, and production setup instructions.

Includes:

  • Getting started
  • Vercel deployment
  • Environment setup
  • Security checklist
  • Monitoring

🎨 Extras

Path: docs/extras/

Additional resources, customization guides, and troubleshooting.

Includes:

  • Branding
  • Custom themes
  • Email templates
  • Cursor AI workflow
  • Resources
  • Troubleshooting

🎯 Documentation Philosophy

ShipSafe documentation follows these principles:

  1. Comprehensive - Complete guides with examples
  2. Practical - Real code from ShipSafe implementation
  3. Security-First - Security best practices throughout
  4. Boilerplate-Friendly - Easy to customize and extend
  5. Concept + Code - Explains why and shows how

💡 Tips for Using This Documentation

  1. Start with Get Started - If you're new, begin with installation and first steps
  2. Follow Tutorials - Learn by building features step-by-step
  3. Reference Components - Use component docs when building pages
  4. Check Features - Understand how features work before customizing
  5. Review Security - Always review security docs before production

🤝 Contributing

Found an error or have a suggestion?

  • Open an issue on GitHub
  • Submit a pull request
  • Share feedback with the community

Built with ShipSafe - A security-first SaaS boilerplate ⚡