Skip to content

Latest commit

 

History

History
120 lines (73 loc) · 4.22 KB

index.md

File metadata and controls

120 lines (73 loc) · 4.22 KB

Bonfire

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.

Start here

  • Install Bonfire


    Add Bonfire to a CodeIgniter 4 app, set up the database and create your first admin user.

    Installation

  • 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.

    Start the tutorial

  • Use Bonfire on your public site


    Add assets, view components, alerts, cookie consent and stored settings to the pages your visitors see.

    Building Sites

  • Look up a config key


    Every config class Bonfire publishes to app/Config, with each key, its default and what it does.

    Configuration Reference

  • Work with an AI agent


    Give coding agents Bonfire's conventions, so they write modules instead of plain controllers.

    Working With AI Agents

  • See what changed


    What changed and when, with breaking changes marked.

    Change Log

Requirements and quick install

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:install

The 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.

What's included

In the admin

For your admin modules

For your site

Getting help

Ask questions in GitHub Discussions and report bugs in GitHub Issues.

License

Bonfire is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

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:

Bonfire contributors

Made with contrib.rocks.