https://github.com/mgatner/bonfire2

CodeIgniter 4-based application skeleton
https://github.com/mgatner/bonfire2

Last synced: 3 months ago
JSON representation

CodeIgniter 4-based application skeleton

• Host: GitHub
• URL: https://github.com/mgatner/bonfire2
• Owner: MGatner
• License: mit
• Fork: true (lonnieezell/Bonfire2)
• Created: 2022-01-09T21:15:39.000Z (almost 3 years ago)
• Default Branch: develop
• Last Pushed: 2023-02-28T05:02:59.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T15:02:47.071Z (almost 2 years ago)
• Language: PHP
• Size: 1.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Bonfire 2

[![Build Status](https://github.com/lonnieezell/Bonfire2/workflows/PHPUnit/badge.svg)](https://github.com/lonnieezell/Bonfire2/actions?query=workflow%3A%22PHPUnit%22)

[![Coverage Status](https://coveralls.io/repos/github/lonnieezell/Bonfire2/badge.svg?branch=develop)](https://coveralls.io/github/lonnieezell/Bonfire2?branch=develop)

[![GitHub license](https://img.shields.io/github/license/lonnieezell/Bonfire2)](https://github.com/lonnieezell/Bonfire2/blob/develop/LICENSE)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/lonnieezell/Bonfire2/pulls)

Just getting started. More details at [Patreon](https://www.patreon.com/lonnieezell)

## What is Bonfire?

Bonfire will be a robust application skeleton for CodeIgniter 4-based applications. It provides a number of helpful

libraries to assist you in making better software for your clients, faster, while allowing you to focus on the 

new parts that matter to each specific application. 

Currently includes the following features: 

- Theme/template system, that ships with a flexible Auth and Admin theme.

- View Components to reduce the complexity of your UI by allowing you to create reusable HTML snippets, that can be optionally controlled via code.

- A Settings library that allows you to save config file values to the database and access them whether they're in the db or just in the files. 

- Resource Filter system to make filtering lists of User, Post, etc, simple to implement and with a comfortable, consistent UI.

- A powerful, very customizable, user authentication/authorization system, [Shield](https://github.com/lonnieezell/codigniter-shield).

- Global search feature that modules can easily integrate into

- A Recycle Bin to handle restoring/purghing soft deleted models that modules can easily integrate into

- A simple documenation system that allows you to provide guides for your clients, or your development teams. 

- and more to come... 

## Server Requirements

This currently has the same requirements as CodeIgniter 4.

## Installation

Installation is a simple 2-step process:

```php

> composer create-project lonnieezell/bonfire app --stability dev

> cd app

> php spark bf:install

```

Find more details in the [docs folder](_docs).

## Third Party Software Used

- [Bootstrap 5](https://getbootstrap.com/) for the CSS foundation

- [FontAwesome 5](https://fontawesome.com/) icons used in the admin 

- [Alpine.js](https://alpinejs.dev/) handles interactivity within the page for the admin area.

- [htmx](https://htmx.org/) provides AJAX form handling, and more.

- [Tatter/Alerts](https://github.com/tattersoftware/codeigniter4-alerts) CodeIgniter library for simple user alerts.