UserFrosting
Features
Demo
Docs
Forums
Chat
Github
Donate
6.0 Beta
6.0 Beta
Features
Demo
Docs
Forums
Chat
Github
Donate
6.0 Beta
6.0 Beta
Documentation
Quick Start Guide
Web Dev, the Right Way
Introduction
The Client-Server Conversation
Develop Locally, Serve Globally
Don't Reinvent the Wheel
Security
Server Misconfiguration
Search Engine Optimization
App Structure
Your Application
Built on the shoulders of giants
The Framework
Sprinkles, what are they?
Installation
Requirements
Basic Stack Requirements
Essential Tools for Modern PHP
Dev Environment
Native Installation
Installing Requirements
Installing UserFrosting
Docker
Troubleshooting
Debugging
Getting Help
Common Problems
Sprinkles
Basic concept
Contents
The Sprinkle Recipe
Customizing Your Sprinkle
Community Sprinkles
Dependency Injection
Understanding Dependency Injection
The DI Container
Default Services
Adding Services
Extending Existing Services
Routes and Controllers
Introduction
RESTful Design
RESTful Endpoints
RESTful Responses
Front Controller
Controller Classes
Registering Routes
Client Input
Validation
CSRF Protection
Throttling
AJAX Requests
Configuration
Environment Variables
Configuration Files
Users
User Accounts
Authorization
Groups
Activity Logging
Bakery CLI
Built-in Commands
Custom Commands
Extending Aggregator Commands
Pages and Twig Templating
Why use Twig?
Sprinkle Templates
Twig Filters and Functions
Assets
Webpack Encore
Referencing static assets
Entrypoints
Enabling Sass, Less, Vue and React
Database
Overview
Default Tables
Migrations
Database Seeding
Data Sprunjing
Client-side Code
Overview
Exporting Variables to Javascript
Client-side Templating
Components
Forms
Tables
Collections
Alerts
Mail
The Mailer Service
Internationalization
Introduction
Setting up the site language
The translator
Creating a custom locale
Advanced Dev Features
Using Custom Data Models
Application Lifecycle
Exceptions and Error Handling
Sessions
Cache
What, Why, and When?
The Cache Service
The Alert Stream
Locator Service
Logging
File Storage
Events
Middlewares
Testing
Why Use Automated Testing ?
Running Tests
Writing Your Own Tests
Sprinkle Test Case
Helper Traits & Class
Factories
Recipes
Creating a new page
Extending the User model
Extending templates and menus
Customizing the login page
Changing user permissions
Adding a 3rd party Javascript package
Advanced tutorial
Setting up the basics
Integrating the Database
Adding the page to the menu
Adding custom authorization
Adding localizations
Customizing the Skeleton
Going further
Going Live
Hosting Your Site
Mail Providers
VPS Production Environment
Server Setup
Using Git for Deployment
Application Setup
SSL/HTTPS
Additional Recommendations
Backing up Your Data
Unix Primer for Ubuntu
Upgrading
4.x to 5.0
What's new ?
Upgrade Guide
Future Roadmap
5.0.x to 5.1.x
What's new in 5.1
Upgrade Guide
Coming up next
Giving Back to UF
Supporting UserFrosting
API Documentation
API Documentation
Edit this page
API Documentation