Quick Start Guide
Obsolete page
This page requires updating for UserFrosting 6. You can help by contributing on GitHub.
UserFrosting is a free, open-source jumping-off point for building user-centered web applications with PHP and Javascript. It comes with a sleek, modern interface, basic user account features, and an administrative user management system - all fully functioning out of the box.
Note
This quick start guide is aimed at experienced PHP developers who already have a development environment set up. If that's not your case, head over to the First Chapter to start your journey.
Important
This is the documentation for UserFrosting 5. If you are looking for documentation for UserFrosting 4, click here.
Requirements
Tip
Using Docker? Check out the Docker Documentation to install UserFrosting through it's native Docker integration.
UserFrosting has a few system requirements. You need to make sure your local UserFrosting development environment meets the following requirements:
- PHP 8.1 or higher (8.3 recommended)
- Composer 2
- Node.js 18.0 or higher, and npm 9.0 or higher
Installing UserFrosting
Use Composer to create an empty project with the latest version of UserFrosting skeleton into a new UserFrosting folder. This will clone the skeleton repository and run the installation process.
composer create-project userfrosting/userfrosting UserFrosting "^5.1"
Tip
During installation, you can choose sqlite as database provider if you don't have a database provider available.
If any dependencies are not met, an error will occur. Simply try again after fixing said error, or manually run composer install and php bakery bake from the install directory. For more information about the bake command, head to the Bakery CLI chapter.
At this point you can run locally using the PHP Server :
cd UserFrosting
php bakery serve
You can now access UserFrosting at : http://localhost:8080
Visit your website
At this point, you should be able to access your application. You should see a basic page:
What's next...
For more detailed information about installing UserFrosting, or if you need help with the basic setup requirements, check out the Installation Chapter. Otherwise, head over to the Sprinkles Chapter.