Bonfire gives new or existing CodeIgniter 4 applications a ready-to-use admin area and the tools to build on it. It does not aim to be a full CMS, but rather a framework to help you build your own web application or internal tools. These docs are for the developers doing that building.
-
Install Bonfire
Add Bonfire to a CodeIgniter 4 app, set up the database and create your first admin user.
-
Build your first admin module
Go from an empty folder to a Posts screen with a menu item, a permission, search, filters and the Recycler.
-
Use Bonfire on your public site
Add assets, view components, alerts, cookie consent and stored settings to the pages your visitors see.
-
Look up a config key
Every config class Bonfire publishes to
app/Config, with each key, its default and what it does. -
Work with an AI agent
Give coding agents Bonfire's conventions, so they write modules instead of plain controllers.
-
See what changed
What changed and when, with breaking changes marked.
Bonfire needs PHP 8.2 or later and CodeIgniter 4.7 or later. From your project's root, run:
composer require lonnieezell/bonfire
php spark bf:installThe installer asks for your site's URL and database details, then publishes Bonfire's config files and themes into your app. Installation covers the remaining steps: creating the database and your first user.
- A dashboard each admin can arrange with their own widgets.
- Users, and groups and permissions, with login and registration through Shield.
- General and email settings screens.
- System info and log viewers.
- A Recycler to restore or purge soft-deleted records.
- A global search your modules can add results to.
- Menus to add your pages to the sidebar.
- Filters and row and bulk actions for lists.
- Dashboard widgets, including stat cards and charts.
- Resource tabs on the user and group edit pages.
- Admin view components for consistent pages and forms.
- Themes published into your app, and asset handling with cache-busting.
- View components for reusable HTML.
- A cookie consent framework to help you comply with GDPR.
- Meta info to store extra fields on users or your own entities without changing their tables.
- A settings library that saves config values to the database.
Ask questions in GitHub Discussions and report bugs in GitHub Issues.
Bonfire is licensed under the MIT License - see the LICENSE file for details.
Every open-source project depends on its contributors to be a success. The following users have contributed in one manner or another in making Bonfire:
Made with contrib.rocks.