Table of Contents
Getting Started with ShipSaaS
Welcome to ShipSaaS! If you're looking to build and launch a SaaS application quickly, you've come to the right place. ShipSaaS is a complete Next.js boilerplate that includes everything you need to create a profitable SaaS business.
What is ShipSaaS?
ShipSaaS is a comprehensive development platform that provides:
- 🚀 Next.js 15 Framework - Built on the latest Next.js with React 19
- 🔐 Authentication System - Complete user management with NextAuth.js
- 💳 Payment Integration - Stripe integration for subscriptions and one-time payments
- 🌍 Internationalization - Multi-language support with next-intl
- 📧 Email System - Newsletter and transactional emails
- 📊 Dashboard - User and admin dashboards
- 📝 Blog & Docs - Built-in blog and documentation system
- 🎨 UI Components - Beautiful components with TailwindCSS
- 🔍 SEO Optimized - Built-in SEO best practices
Quick Start Guide
1. Installation
First, clone the ShipSaaS repository and install dependencies:
git clone https://github.com/your-repo/shipsaas.git
cd shipsaas
pnpm install
2. Environment Setup
Copy the environment variables and configure your settings:
cp .env.example .env.local
Update your .env.local
file with:
# Database
DATABASE_URL="your-neon-database-url"
# Authentication
NEXTAUTH_SECRET="your-secret-key"
NEXTAUTH_URL="http://localhost:3000"
# OAuth Providers
GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-client-secret"
GITHUB_CLIENT_ID="your-github-client-id"
GITHUB_CLIENT_SECRET="your-github-client-secret"
# Stripe
STRIPE_SECRET_KEY="your-stripe-secret-key"
STRIPE_PUBLISHABLE_KEY="your-stripe-publishable-key"
STRIPE_WEBHOOK_SECRET="your-webhook-secret"
3. Database Setup
ShipSaaS uses Neon PostgreSQL for the database. Run the migrations:
pnpm db:migrate
pnpm db:seed
4. Start Development
Launch the development server:
pnpm dev
Your application will be available at http://localhost:3000
.
Key Features Overview
Authentication System
ShipSaaS includes a complete authentication system with:
- Social Login - Google and GitHub OAuth
- Email/Password - Traditional authentication
- Password Reset - Email-based password recovery
- User Profiles - Customizable user profiles
- Role Management - Admin and user roles
Payment Integration
The Stripe integration provides:
- Subscription Plans - Multiple pricing tiers
- One-time Payments - For additional features
- Billing Management - Customer portal integration
- Webhook Handling - Automatic subscription updates
Dashboard System
Both user and admin dashboards include:
- Analytics - Usage and revenue metrics
- User Management - Admin user controls
- Billing Overview - Subscription status
- Settings - Account configuration
Customization Guide
Branding
Update your brand colors and styling in:
// tailwind.config.ts
export default {
theme: {
extend: {
colors: {
brand: {
50: '#eff6ff',
500: '#3b82f6',
900: '#1e3a8a',
}
}
}
}
}
Adding Features
ShipSaaS is designed to be extensible. You can easily add new features by:
- Creating new API routes in
src/app/api/
- Adding new pages in
src/app/[locale]/
- Building custom components in
src/components/
- Extending the database schema in
src/lib/db/
Deployment
Vercel Deployment
ShipSaaS is optimized for Vercel deployment:
pnpm build
vercel --prod
Environment Variables
Make sure to set all required environment variables in your production environment.
Database Migration
Run database migrations in production:
pnpm db:migrate:prod
Next Steps
Now that you have ShipSaaS running, here are some recommended next steps:
- Customize Your Landing Page - Update the hero section and features
- Configure Payment Plans - Set up your Stripe products and pricing
- Add Your Content - Create blog posts and documentation
- Set Up Analytics - Integrate Google Analytics or other tools
- Configure Email - Set up transactional and marketing emails
Support and Community
- Documentation - Comprehensive guides and API reference
- Community - Join our Discord community
- Support - Priority support for premium users
- Updates - Regular feature updates and improvements
Conclusion
ShipSaaS provides everything you need to build and launch a successful SaaS application. With its comprehensive feature set and modern architecture, you can focus on building your unique value proposition instead of reinventing the wheel.
Ready to start building? Check out our component library and configuration guide to learn more about customizing ShipSaaS for your needs.
Happy building! 🚀