This quick start guide is aimed at experienced PHP developers who already have a development environment set up. Head over to the Installation Chapter for the complete guide.
This is the documentation for UserFrosting 4. If you are looking for documentation for previous versions of UserFrosting, please see here.
UserFrosting has a few system requirements. Of course, all of these requirements are satisfied by the Homestead virtual machine, so it's highly recommended that you use Homestead as your local UserFrosting development environment.
However, if you are not using Homestead, you will need to make sure your local UserFrosting development environment meets the following requirements:
Use git to clone the latest version of UserFrosting into a new
$ git clone https://github.com/userfrosting/UserFrosting.git userfrosting
Once the project is created using composer,
cd into the newly created
userfrosting folder and run the following command to fetch the composer dependencies:
$ composer install
Now run the final setup by calling the Bakery CLI:
$ php bakery bake
This will run the installation process:
If any dependencies are not met, an error will occur. Simply run the command again after fixing said error. For more information about the
bake command, head to the Bakery CLI chapter.
After installing UserFrosting, you should configure your web server's document / web root to be the
/public directory. The
index.php in this directory serves as the front controller for all HTTP requests.
UserFrosting needs to be able to write to the file system for a few directories:
UserFrosting includes a
public/.htaccess file that is used to provide URLs without the index.php front controller in the path. Before serving UserFrosting with Apache, be sure to enable the
mod_rewrite module so the
.htaccess file will be honored by the server.
Use the configuration file provided in
Please see the section on Configuring for IIS.
At this point, you should be able to access your application. You should see a basic page:
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.