phpdev-uk/slim-skeleton

Skeleton Slim 4 application

dev-main 2024-04-18 10:16 UTC

Requires

• php: >=7.4
• ext-mysqli: *
• doctrine/annotations: ^1.13
• doctrine/dbal: ^3.3
• doctrine/migrations: ^3.5
• doctrine/orm: ^2.10
• filp/whoops: ^2.14
• php-di/php-di: ^6.3
• slim/csrf: ^1.3
• slim/http: ^1.3
• slim/psr7: ^1.5
• slim/slim: 4.*
• slim/twig-view: ^3.2
• symfony/cache: ^5.3
• symfony/mailer: ^5.4
• twig/intl-extra: ^3.3
• twig/twig: ^3.3
• vlucas/phpdotenv: ^5.3

Requires (Dev)

• phpstan/phpstan: ^1.4
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.6

MIT

• Paul Waring

README

Skeleton Slim 4 application for new projects.

This package makes it quicker to bootstrap a new Slim 4 application with common dependencies and a local development environment using Docker. It is only intended to be used as an initial bootstrap - after that you should commit your changes to your own Git repository and manage your Composer dependencies.

If you are using Visual Studio Code, there are also some settings to integrate Xdebug and to ignore third party libraries (vendor/) and the database file.

Installation

Create a project via Composer (do not use composer require as this will add phpdev-uk/slim-skeleton as a dependency):

composer create-project phpdev-uk/slim-skeleton:dev-main my-app

Set your PHP version in composer.json.

Change any image versions in docker-compose.yml to match your production environment.

Make any changes to .env.

Start Docker:

docker-compose up

Visit https://docker.localhost in your browser.

Assumptions

This skeleton application makes the following assumptions about your application environment:

• PHP 7.4
• Single MariaDB database
• Debian Bullseye (latest stable release)

Included libraries

Although you do not have to use them, this package includes the following libraries:

• Doctrine ORM: Create PHP classes to map to your database structure.
• Doctrine Migrations: Manage changes to your database schemas.

If you are using a database in your application, the above libraries are likely to make your life much easier.

Middleware

This skeleton repository comes with an AuthRequired middleware class, which can be used to place routes behind a authentication wall. You will need to either make sure that your authentication code sets $_SESSION['logged_in'] to true when the user is authenticated, or edit the class to use your authentication process.

The setup assumes that you are using sessions for authentication. In order for session_start to be called, you must enable CSRF protection in your .env file (it is enabled by default). Authentication without CSRF is not recommended.