README

A simple boilerplate to begin building an application using the Bones framework.

• License
• Author
• Requirements
• Installation
• Documentation

License

This project is open source and available under the MIT License.

Author

• Bayfront Media homepage
• Bayfront Media GitHub

Requirements

• PHP ^8.0 (Tested up to 8.4)

Installation

When deploying to DigitalOcean, be sure to update and encrypt the APP_KEY environment variable as described below.

Create project

composer create-project bayfrontmedia/bones-app PROJECT_NAME

Define environment variables

Rename .env.example to .env and update. (see docs)

NOTE: Be sure to define a cryptographically secure app key for the APP_KEY variable.

Once Bones is installed, you can use the php bones install:key command to replace SECURE_APP_KEY with a valid key, or you can use the php bones make:key command to generate a key you can define manually.

Configure the app

Update config/app.php as needed. (see docs)

Set file permissions

The web server must have write permissions to the storage/app directory. Typically, this is done by granting the www-data group ownership and write access:

chgrp -R www-data /path/to/storage/app
chmod -R 775 /path/to/storage/app

Start using Bones

You are now ready to begin building your application!

At this point, Bones should be installed and ready to use. You can test this by running the console command php bones about:bones, or by viewing the public web root in your browser.

Optional services

Optional services can be installed by using the php bones install:service console command.

Documentation

Documentation for this application can be found here.

For more information, see Bones documentation.