Documentation
Complete guide to setting up, customizing, and deploying your LaraBolt SaaS application.
Note: This is a quick reference. For detailed guides, see the comprehensive documentation files included with your purchase: README.md,TESTING.md, andDEPLOYMENT.md.
Getting Started
Installation
After purchasing LaraBolt, you'll receive access to the complete source code. Follow these steps to get started:
- Clone or download the repository
- Set up your backend environment (Laravel)
- Configure your frontend (Next.js)
- Set up your database (PostgreSQL or MySQL)
- Configure environment variables
- Run migrations and seeders
Prerequisites
- PHP 8.2 or higher
- Composer
- Node.js 20 or higher
- PostgreSQL 14+ or MySQL 8+
- Git
For detailed installation instructions, see README.md in your project root.
Configuration
Environment Variables
Configure your application through environment variables in .env files.
# Backend (.env) APP_NAME=LaraBolt APP_URL=http://localhost:8000 DB_CONNECTION=pgsql # or mysql DB_HOST=127.0.0.1 DB_DATABASE=larabolt DB_USERNAME=your_user DB_PASSWORD=your_password # Payment Gateway (choose one) STRIPE_KEY=your_stripe_key STRIPE_SECRET=your_stripe_secret # OR LEMON_SQUEEZY_API_KEY=your_lemonsqueezy_key # OR DODO_API_KEY=your_dodo_key DODO_API_SECRET=your_dodo_secret # Email RESEND_KEY=your_resend_api_key MAIL_FROM_ADDRESS=noreply@yourdomain.com
Database Configuration
LaraBolt supports both PostgreSQL and MySQL. Switch between them by changing theDB_CONNECTION in your .env file.
All migrations are database-agnostic and will work with either database system.
Payment Gateway Setup
Choose your payment gateway and configure it in the environment variables. The codebase includes adapters for:
- Stripe: Configure STRIPE_KEY and STRIPE_SECRET
- Lemon Squeezy: Configure LEMON_SQUEEZY_API_KEY
- Dodo Payments: Configure DODO_API_KEY and DODO_API_SECRET
Update the PaymentService to use your chosen gateway.
Features & Customization
Authentication System
The authentication system includes:
- User registration with email verification
- Login and logout functionality
- Password reset via email
- Magic link authentication (optional)
- Laravel Sanctum for API authentication
Customize authentication flows in app/Http/Controllers/Auth/
Email System (Resend API)
Email functionality is powered by Resend API. Configure your Resend API key in the environment variables.
Available email features:
- Email verification
- Password reset emails
- Purchase confirmations
- Custom notifications
Customize email templates in resources/views/emails/
Admin Panel (Filament)
Access the admin panel at /admin. The panel includes:
- User management
- Product management
- Subscription management
- Dashboard with statistics
Customize admin resources in app/Filament/Resources/
Extensions
Extend your SaaS with additional features through Extensions:
- Blog Extension - Content management system
- Ecommerce Extension - Online store functionality
- Marketplace Extension - Multi-vendor platform
- Job Board Extension - Recruitment system
- Facet Search Extension - Advanced search
- AI Tools Extension - AI-powered features
Each extension comes with installation instructions and documentation.
API Documentation
Authentication Endpoints
POST /api/register
POST /api/login
POST /api/logout
POST /api/forgot-password
POST /api/reset-password
GET /api/verify-email/{id}/{hash}
POST /api/email/verification-notificationUser Endpoints
GET /api/user PUT /api/user
Product & Subscription Endpoints
GET /api/products
GET /api/products/{id}
GET /api/subscription
POST /api/subscription
DELETE /api/subscriptionWebhooks
POST /api/webhooks/dodo
Configure webhook URLs in your payment gateway dashboard to point to this endpoint.
Deployment
Frontend (Next.js)
Deploy your Next.js frontend to Vercel, Netlify, or any static hosting service:
- Build the application:
npm run build - Configure environment variables in your hosting platform
- Set up custom domain (optional)
- Enable automatic deployments from Git
For detailed Vercel deployment instructions, see DEPLOYMENT.md.
Backend (Laravel)
Deploy Laravel to DigitalOcean, AWS, or any PHP hosting:
- Set up server with PHP 8.2+ and required extensions
- Install Composer dependencies
- Configure environment variables
- Run migrations:
php artisan migrate - Set up queue workers (if using queues)
- Configure web server (Nginx/Apache)
- Set up SSL certificate
For step-by-step deployment guides for Vercel, DigitalOcean, and cPanel, see DEPLOYMENT.md.
Database
Set up your production database:
- Create production database
- Configure connection in
.env - Run migrations
- Set up database backups
Comprehensive Documentation Files
LaraBolt includes three comprehensive documentation files that cover every aspect of the project. These are included with your purchase and provide detailed guides beyond this quick reference.
README.md
Your starting point for everything LaraBolt. Complete overview, installation guide, features, and quick start instructions.
- ✓ Project overview & structure
- ✓ Step-by-step installation
- ✓ Configuration guide
- ✓ Tech stack details
- ✓ First steps after installation
Start here: Read this first to get up and running quickly.
TESTING.md
Complete testing guide with examples, best practices, and CI/CD integration. Ensure your code works before deployment.
- ✓ Backend test suites (Laravel)
- ✓ Frontend testing (Next.js/Jest)
- ✓ Running tests locally
- ✓ CI/CD integration examples
- ✓ Test coverage & best practices
Before deploying: Learn how to test your application thoroughly.
DEPLOYMENT.md
Step-by-step deployment guides for various platforms and hosting providers. Go from development to production.
- ✓ Vercel deployment (Frontend)
- ✓ DigitalOcean setup (Backend)
- ✓ cPanel configuration
- ✓ Database setup & migration
- ✓ Environment configuration
When ready: Follow these guides to deploy to production.
Where to Find These Files
All documentation files are included in the root directory of your LaraBolt installation:
These markdown files are comprehensive guides that go into much more detail than this quick reference page. They include code examples, troubleshooting tips, and platform-specific instructions.
Support & Resources
Getting Help
If you need assistance:
- Email: support@larabolt.io
- Review the comprehensive documentation files included with your purchase:
README.md- Installation and setupTESTING.md- Testing guide and examplesDEPLOYMENT.md- Production deployment guides
- Check the code comments for inline documentation
- Review the test files for usage examples (see TESTING.md)
Documentation Structure
The documentation is organized to help you at every stage:
- README.md: Start here for installation and overview
- TESTING.md: Learn how to test your application
- DEPLOYMENT.md: Deploy to production with confidence
- This Docs Page: Quick reference and feature overview
Customization Tips
- All code is well-commented and follows Laravel/Next.js best practices
- Use the existing patterns when adding new features
- Follow the established folder structure
- Write tests for new features - see
TESTING.mdfor examples - Review deployment guides before going live - see
DEPLOYMENT.mdfor platform-specific instructions
Recommended Reading Order
- README.md - Start here to understand the project and get it running locally
- This Docs Page - Quick reference for features and API endpoints
- TESTING.md - Learn how to test your application before deployment
- DEPLOYMENT.md - When ready, follow these guides to deploy to production