dappur/framework

A stylish PHP application framework crafted using Slim, Twig, Eloquent and Sentinel designed to get you from clone to production in a matter of minutes.


README

A stylish PHP application framework crafted using Slim, Twig, Eloquent and Sentinel designed to get you from clone to production in a matter of minutes.

Built on the Slim PHP Micro Framework, Twig templating engine, Eloquent ORM database interactions, Phinx database migrations, Sentinel user management, Monolog w/ Logentries Support, form validation with CSRF protection, cookie management, database controlled config,Cloudinary CMS integration, blog, SEO, oauth2 login, and two-factor authentication.

This is a lightweight full featured framework intended for PHP developers who need an open source, fast and reliable platform to build your apps from. Have your new projects up and running in minutes with the provided basic bootstrap pages and basic bootstrap admin.

Important Links

Demo
Documentation
Changelog
dApp CLI

Created Using

  • Slim - Slim is a PHP micro framework that helps you quickly write simple yet powerful web applications and APIs
  • Slim Twig-View - Slim Framework 3 view helper built on top of the Twig 2 templating component
  • Slim Flash Messaging - Slim Framework Flash message service provider
  • Slim CSRF - Slim Framework 3 CSRF protection middleware
  • Slim Validation - A validator for Slim micro-framework using Respect\Validation
  • Cartalyst Sentinel - PHP 5.4+ Fully-featured Authentication & Authorization System
  • Illuminate Database - The Illuminate Database component is a full database toolkit for PHP, providing an expressive query builder, ActiveRecord style ORM, and schema builder.
  • Monolog Logging - Send logs to files, sockets, inboxes, databases and various web services.
  • Fig Cookies - Cookies for PSR-7 HTTP Message Interface.
  • Phinx Database Migrations - Phinx makes it ridiculously easy to manage the database migrations for your PHP app.
  • Cloudinary Image CDN - Cloudinary is a cloud service that offers a solution to a web application's entire image management pipeline.
  • PHPMailer - A full-featured email creation and transfer class for PHP.
  • Paginator - A lightweight PHP paginator, for generating pagination controls in the style of Stack Overflow and Flickr.
  • UUID - A PHP library for generating RFC 4122 version 1, 3, 4, and 5 universally unique identifiers (UUID).
  • Jobby - Manage all your cron jobs without modifying crontab. Handles locking, logging, error emails, and more.
  • TwoFactorAuth - PHP library for Two Factor Authentication (TFA / 2FA)

Frontend Theme

This framework comes with several pre-made Bootstrap pages to help get your project moving. All of these pages and their respective controllers/views provide you an insight into how the framework functions including form validation, CSRF, working with Eloquent ORM and other plugins. You can expand on the default template or create a completely new template using Twig and the front-end framework of your choosing.

Dashboard Theme

In addition to the few basic front end templates, this framework also comes pre-built with a basic Bootstrap 3 admin dashboard. This dashboard can be accessed automatically by logging in with the admin user credentials.

//TODO

  • Create Documentation
  • Beef up the dApp CLI
  • Add Unit Testing

Pre-Requisites

PHP - PHP is a popular general-purpose scripting language that is especially suited to web development

MySQL Server - MySQL Server, the world's most popular open source database, and MySQL Cluster, a real-time, open source transactional database.

Composer - Dependency manager is required in order to use the Dappur PHP Framework. Installation Instructions

Phinx - Phinx is required in order to utilize the database migrations. It is recommended that you install Phinx globally via composer by running:

$ composer global require robmorgan/phinx

Install with dApp

This command clones your project via the composer create-project command and downloads the themes as well as prepare your settings.json file.

$ dapp new new_app

Install Via Composer

Step 1 (Create the project)

You can start a new project user the Composer create-project command.

$ composer create-project dappur/framework new_app

Step 2 (Install the themes)

If you install via composer, you will have to install both of the themes manually. Simply copy the theme folder from the theme repository into you app/views folder inside your project. If you are using a custom theme, you will have to change the initial migration to support that theme before you migrate your database.

Step 3 (Prepare settings.json file)

Inside the root of your project, you will need to copy the settings.json.dist to settings.json.

$ cp settings.json.dist settings.json

Once copied, open settings.json and change the "framework" name to your project name. You can also set up any other options as well as your database credentials.

Quick Start Via Vagrant

Once installed, run vagrant up in the project root to provision a box that contains:

- Ubuntu 18
- PHP 7.2
- Composer
- Phinx
- MariaDB 10.3
- Apache 2

The script will also fetch dependencies, create a dev database, and run the initial migration for you. Services will be accessible through:

Initial Database Migration

If you are not using Vagrant, you have one more step to go before you are live. You will need to ensure that you database credentials are correct in settings.json and then run the following command in a terminal from your root project directory:

$ phinx migrate

Run & Test Project

If you've chosen to use vagrant, you can simply visit the configured URL:PORT after completing the vagrant up command. Otherwise, once you have successfully done the initial migration, you can simply use PHP's built in web server to test your application by running the following from your root project directory:

$ php -S localhost:8181 -t public

Navigate to http://localhost:8181 to view your project.

Default Admin Username: admin
Default Admin Password: admin123

It is HIGHLY recommended that you change the password immediately after your initial migration.