bayfrontmedia / bones-web
A simple boilerplate to begin building a web application with Tailwind using the Bones framework.
Installs: 7
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Type:project
Requires
- php: ^8.0
- ext-pdo: *
- bayfrontmedia/bones: ^5.2
- bayfrontmedia/php-cookies: ^2.0
- bayfrontmedia/translation: ^2.0
- league/flysystem: ^3.28
- monolog/monolog: ^3.7
README
A simple boilerplate to begin building a web application with Tailwind using the Bones framework.
It includes:
- Router
- Job scheduler
- Veil template engine with custom template tags
- Translations
- Flysystem
- Logging
- Frontend built using the Skin Tailwind CSS plugin
- Webpack to bundle JavaScript
License
This project is open source and available under the MIT License.
Author
Requirements
- PHP
^8.0 - PDO PHP extension
- npm
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-web PROJECT_NAME
cd PROJECT_NAME
npm install
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
Setup a cron job
If a cron job will be used to run the scheduled jobs, add a new entry to your crontab to run every minute:
* * * * * /path/to/php/bin cd /path/to/your/app && php bones schedule:run >> /dev/null 2>&1
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.