Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.99 KB

README.md

File metadata and controls

58 lines (38 loc) · 1.99 KB
Raw

saeven-laminas-mvc-skeleton

Introduction

This is a skeleton application based on the Laminas MVC skeleton that adds AlpineJS, Twig, Doctrine, Circlical/User, Assetic, TailwindCSS and more!

demo.mov

It gives you

  • Twig templates, ready to go.
  • Doctrine all wired up
  • Full authentication with all required pages and emails (registration, login, forgot password request, set a new password, and account validation)

Installation

  • Clone this project, composer install
  • Create a MySQL database for the project
  • Enter your database details into config/autoload/database.local.php
  • Spawn your database tables with the Doctrine CLI
$ ./vendor/bin/doctrine-module orm:schema-tool:update --force

This ought to run 20 queries or so (at time of writing). With the tables in place with all rights granted to your user, issue this query:

INSERT INTO `skeleton`.`acl_roles` (`name`)
VALUES ('user')

Test it out immediately using PHP's built-in web server:

$ cd path/to/install
$ php -S 0.0.0.0:8080 -t public
# OR use the composer alias:
$ composer run --timeout 0 serve

This will start the cli-server on port 8080, and bind it to all network interfaces. You can then visit the site at http://localhost:8080/

  • which will bring up this sample rig.

Note: The built-in CLI server is for development only.

Post-Install Configuration

  • configure your database details within config/autoload/database.local.php
  • configure the application name and your email within config/autoload/global.php
  • configure your Mailgun credentials within config/autoload/mailgun.local.php
  • pop your logo into public/assets/images

Tweaking Email Content

Emails are created by Maizzle, an open-source email-template compiler. In this skeleton, they automatically compile into the right place within the Laminas framework. You can see the Maizzle framework within maizzle/emails; do check out its README.