Welcome to ShipSafe! This section will help you get up and running quickly.

Overview

ShipSafe is a security-first Next.js SaaS boilerplate that helps you build production-ready applications with Firebase, Stripe, and comprehensive security features.

What you'll learn:

• How to set up your development environment
• How to configure Firebase and Stripe
• How to understand the project structure
• How to customize your app settings

Quick Start Guide

1. Installation & Setup

Get your local development environment ready:

• Install dependencies
• Set up environment variables
• Configure Firebase
• Configure Stripe
• Run your first app

Time: ~15 minutes
Perfect for: First-time setup

2. First Steps

Run your first app and understand the basics:

• Start the development server
• Explore the default pages
• Understand the authentication flow
• Test the billing integration

Time: ~10 minutes
Perfect for: Understanding the boilerplate

3. Project Structure

Learn how the codebase is organized:

• Folder structure explained
• Component organization
• Feature architecture
• Configuration files

Time: ~15 minutes
Perfect for: Understanding the architecture

4. Configuration

Customize your app settings:

• Update config.ts
• Change app name and branding
• Configure Stripe plans
• Customize themes
• Set up authentication routes

Time: ~10 minutes
Perfect for: Customizing your app

Recommended Learning Path

For First-Time Users

1. Start here: Installation
2. Then: First Steps
3. Next: Project Structure
4. Finally: Configuration

For Experienced Developers

1. Quick setup: Installation - Just the essentials
2. Understand structure: Project Structure
3. Customize: Configuration
4. Start building: Jump to Tutorials

What's Next?

After completing the Get Started guides:

• Tutorials - Build features step-by-step
• Features - Understand all features
• Components - Use pre-built components
• Security - Learn security best practices

Common Questions

How long does setup take?

First-time setup: ~30-45 minutes (including Firebase and Stripe configuration)
Quick setup: ~15 minutes (if you already have Firebase/Stripe accounts)

Do I need prior experience?

No! The documentation is designed for all skill levels. However, familiarity with:

• React/Next.js basics
• TypeScript basics
• Firebase basics (helpful but not required)

What if I get stuck?

• Check Troubleshooting
• Review relevant feature documentation
• Check error messages carefully
• Verify environment variables

Quick Reference

Essential Files

• config.ts - App configuration
• .env.local - Environment variables
• package.json - Dependencies
• tailwind.config.ts - Tailwind/DaisyUI config

Essential Commands

npm install          # Install dependencies
npm run dev          # Start development server
npm run build        # Build for production
npm run lint         # Run linter

Essential Documentation

• Environment Variables - All env vars explained
• Firebase Setup - Firebase configuration
• Stripe Setup - Stripe configuration

Ready to start? Begin with Installation!