https://github.com/samuelgfeller/slim-example-project
Real World Slim 4 Example Project with Front- and Backend, Testing, Auth System, Permissions, Localization and more with a complete documentation.
https://github.com/samuelgfeller/slim-example-project
example-project php-skeleton php-starter skeleton slim slim-framework slim-skeleton slim-starter slim4
Last synced: 6 months ago
JSON representation
Real World Slim 4 Example Project with Front- and Backend, Testing, Auth System, Permissions, Localization and more with a complete documentation.
- Host: GitHub
- URL: https://github.com/samuelgfeller/slim-example-project
- Owner: samuelgfeller
- License: mit
- Created: 2020-11-27T09:47:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-12T13:06:33.000Z (8 months ago)
- Last Synced: 2025-03-30T06:04:42.569Z (6 months ago)
- Topics: example-project, php-skeleton, php-starter, skeleton, slim, slim-framework, slim-skeleton, slim-starter, slim4
- Language: PHP
- Homepage: https://samuel-gfeller.ch/slim-example-project
- Size: 36.5 MB
- Stars: 65
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Slim Example Project
[](https://samuel-gfeller.ch/docs)
[](https://samuel-gfeller.ch/docs/Slim-Example-Project-Installation-Guide)
[](https://scrutinizer-ci.com/g/samuelgfeller/slim-example-project/?branch=master)
[](https://scrutinizer-ci.com/g/samuelgfeller/slim-example-project/build-status/master)
[](https://scrutinizer-ci.com/g/samuelgfeller/slim-example-project/?branch=master)
[](LICENSE)
Real-world example of a modern [Slim 4](https://www.slimframework.com/) web application with a scalable
structure and a variety of components and features.
The project applies current best practices and programming principles,
with a strong emphasis on the [SOLID](https://en.wikipedia.org/wiki/SOLID)
Single Responsibility Principle ([SRP](https://samuel-gfeller.ch/docs/Single-Responsibility-Principle-(SRP))).
External library dependencies
are [kept to a minimum](https://samuel-gfeller.ch/docs/Libraries-and-Framework)
to facilitate maintenance and ensure long-term viability.
The [architecture](https://samuel-gfeller.ch/docs/Architecture)
is inspired by the Domain Driven Design ([DDD](https://en.wikipedia.org/wiki/Domain-driven_design))
and the [Vertical Slice Architecture](https://www.youtube.com/watch?v=L2Wnq0ChAIA).
A detailed [documentation](https://samuel-gfeller.ch/docs) explains how the project is
built,
components, design choices and features.
Stripped down versions of this repository are available as skeleton
templates.
With frontend [**slim-starter**](https://github.com/samuelgfeller/slim-starter) or just for an API:
[**slim-api-starter**](https://github.com/samuelgfeller/slim-api-starter).
Please read the [**installation guide**](https://samuel-gfeller.ch/docs/Slim-Example-Project-Installation-Guide)
to get started.
## Features
All the features were developed with an effort to ensure maximum user-friendliness.
The frontend, intuitive, aesthetically pleasing, minimalistic, and functional.
The backend, efficient and secure.
**Technologies:**
* [Slim 4 micro-framework](https://github.com/slimphp/Slim)
* [Dependency Injection](https://samuel-gfeller.ch/docs/Dependency-Injection) - [PHP-DI](https://php-di.org/)
* [Logging](https://samuel-gfeller.ch/docs/Logging) - [Monolog](https://github.com/Seldaek/monolog)
* [Validation](https://samuel-gfeller.ch/docs/Validation) - [cakephp/validation](https://book.cakephp.org/4/en/core-libraries/validation.html)
* [Database migrations](https://samuel-gfeller.ch/docs/Database-Migrations) - [Phinx](https://phinx.org/)
* [Template rendering](https://samuel-gfeller.ch/docs/Template-Rendering) - [PHP-View](https://github.com/slimphp/PHP-View)
* [Mailing](https://samuel-gfeller.ch/docs/Mailing) - [Symfony Mailer](https://symfony.com/doc/current/mailer.html)
* [Localization](https://samuel-gfeller.ch/docs/Translations) - [gettext](https://www.gnu.org/software/gettext/)
* [Query Builder](https://samuel-gfeller.ch/docs/Repository-and-Query-Builder) - [cakephp/database](https://book.cakephp.org/5/en/orm/query-builder.html)
* [Integration / unit testing](https://samuel-gfeller.ch/docs/Writing-Tests) - [PHPUnit](https://github.com/sebastianbergmann/phpunit/) - [test-traits](https://github.com/samuelgfeller/test-traits)
* [Session and flash messages](https://samuel-gfeller.ch/docs/Session-and-Flash-messages) - [odan/session](https://github.com/odan/session)
* [Error handling](https://samuel-gfeller.ch/docs/Error-Handling) - [slim-error-renderer](https://github.com/samuelgfeller/slim-error-renderer)
* [GitHub Actions](https://samuel-gfeller.ch/docs/GitHub-Actions)
and [Scrutinizer](https://samuel-gfeller.ch/docs/How-to-set-up-Scrutinizer)
* [Coding standards fixer](https://samuel-gfeller.ch/docs/Coding-Standards-Fixer) - [PHP-CS-Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer)
* [Static code analysis](https://samuel-gfeller.ch/docs/PHPStan-Static-Code-Analysis) - [PHPStan](https://github.com/phpstan/phpstan)
**Functionalities demonstrating real-world features:**
This project is currently designed for non-profit organizations or foundations that require a platform
to manage and maintain a record of communication through notes of people they help.
* [Authentication](https://samuel-gfeller.ch/docs/Authentication) (login)
* [Authorization](https://samuel-gfeller.ch/docs/Authorization) (permissions)
* Account verification
and [password reset](https://samuel-gfeller.ch/docs/Authentication#password-forgotten)
via email link and token
* [Request throttling](https://samuel-gfeller.ch/docs/Security#request-throttling) -
protection against brute force and password spraying attacks
* User management for administrators
* 4 user roles and different permissions
* User activity history
* Client creation and mutation with status and attributed user
* Client list filtering by text input and filter chips
* Note creation and mutation
* Hidden notes from unauthorized users
* Dashboard with panels
* [Dark / light theme](https://samuel-gfeller.ch/docs/Dark-Theme)
Click to see demo
Link: [Login](https://demo.slim-example-project.samuel-gfeller.ch)
Username: `admin@user.com`
Password: `12345678`
The database is regularly reset.
## Motivation to create this project
There is a ton of great content on the internet about learning how to write clean and sustainable code.
However, I found myself searching for more than just skeleton projects or general documentations
and tutorials when I wanted to learn how to do things within the scope of a potential real-world application.
I never found resources such as an open-source, efficient implementation of all the features surrounding a
full-sized project.
This is what I try to provide here.
This project isn't just a skeleton, it contains a lot of opinionated
practical examples on how to
implement features that are often necessary in real-world applications.
That includes authorization, integration testing, localization, validation,
error handling, database migrations, mailing, console commands, request throttling,
lightweight PHP template rendering, GitHub Actions, and more along with detailed
explanations in the documentation.
But it's not just about the features.
Equally important
are the [architecture](https://samuel-gfeller.ch/docs/Architecture)
and how the components interact with each other, following modern principles such as the
[Single Responsibility Principle](https://samuel-gfeller.ch/docs/Single-Responsibility-Principle-(SRP))
and
[Dependency Injection](https://samuel-gfeller.ch/docs/Dependency-Injection).
Of course, there are big frameworks that have their own well-established set of programming conventions and
implementations of features.
However, I find them often
too complex, where the code makes too much "behind the scenes" and with lots of dependencies,
which can lead to time-consuming refactoring on version changes.
I also dislike having to follow the propitiatory rules of a framework [which often don't
follow best practices](https://www.reddit.com/r/PHP/comments/131t2k1/laravel_considered_harmful)
and
much prefer the freedom of a micro-framework and carefully
[choosing the libraries](https://samuel-gfeller.ch/docs/Libraries-and-Framework#choosing-the-right-libraries)
and structure
that make sense for the project.
This lets me stay in control of the codebase, keep it lightweight,
performant and tailored to the needs of the project, and it's easier to maintain
and adapt to new requirements.
## Disclaimer
This project and its documentation are the result of my personal learning process in the last 6 years
in trying to create the best possible template app with lots of real world examples.
Three of the 6 years were spent full time on this project alone.
I made what wish I had when I started getting seriously into web development.
The codebase is big and thus lots of subjective decisions had to be made that may not be the best
long-term solution for everybody.
The main focus throughout the development was to make the code as long living as possible
with best practices and few dependencies so that it can be adapted to different needs and
preferences.
Basically, this is my take on what an efficient, extensible, and maintainable web app could look like with today's
tech.
I worked closely with the software engineer and architect
[Daniel Opitz](https://odan.github.io/about.html), who also reviewed this project.
I learned a lot during
[our exchanges](https://samuel-gfeller.ch/docs/Sources-of-Knowledge#discussions)
and was inspired by his books, articles, tutorials and his slim
[skeleton-project](https://github.com/odan/slim4-skeleton).
## Support
Please read the [Support❤️](https://samuel-gfeller.ch/docs/Support❤️) page
if you value this project and its documentation and want to support it.
## License
This project is licensed under the MIT License — see the
[LICENSE](https://github.com/samuelgfeller/slim-example-project/blob/master/LICENSE) file for details.