lhsazevedo/slim-pug-skeleton

A Slim Framework skeleton application with Pug support for rapid development

v3.0.1 2018-12-07 13:46 UTC

This package is auto-updated.

Last update: 2024-10-08 07:32:30 UTC


README

Use this skeleton application to quickly setup and start working on a new Slim Framework 3 application. This application uses the latest Slim 3 with the Pug-php template renderer. It also uses the Monolog logger.

This skeleton application was built for Composer. This makes setting up a new Slim Framework application quick and easy.

Comparison between raw PHP and Pug template files:

Raw PHP template body (10 lines, 259 chars):

<body>
  <h1>Slim</h1>
  <div>a microframework for PHP</div>

  <?php if (isset($name)) : ?>
    <h2>Hello <?= htmlspecialchars($name); ?>!</h2>
  <?php else: ?>
    <p>Try <a href="http://www.slimframework.com">SlimFramework</a></p>
  <?php endif; ?>
</body>

Pug template body (8 lines, 148 chars):

body
  h1 Slim
  div a microframework for PHP

  if name
    h2 Hello #{name}!
  else
    p Try #[a(href="https://slimframework.com") SlimFramework]

Install the Application

Run this command from the directory in which you want to install your new Slim Framework application.

php composer.phar create-project lhsazevedo/slim-pug-skeleton [my-app-name]

Replace [my-app-name] with the desired directory name for your new application. You'll want to:

  • Point your virtual host document root to your new application's public/ directory.
  • Ensure logs/ is web writeable.

To run the application in development, you can run these commands

cd [my-app-name]
php composer.phar start

Run this command in the application directory to run the test suite

php composer.phar test

That's it! Now go build something cool.