carlonicora/minimalism

Minimal MVC framework

13.7.2 2020-12-28 00:00 UTC

This package is auto-updated.

Last update: 2024-04-12 16:15:34 UTC


README

Minimalism is a modular MVC (Model-View-Controller) framework for PHP 8.1. Minimalism is written to support both Webpages as well as APIs. The framework is small and doesn't offer many functions "off the hook", but it has been build with extensibility in mind. You can use minimalism without any other frills, or you can install one of the many services already present and use those functionalities.

Minimalism is tested, but please keep in mind this is a project which is maintained to support projects which we are currently developing. This means the time and effort we can put on minimalism is not as much as we would love.

Why did we write minimalism?

Yes, there are lots of frameworks out there, we appreciate it. Yet, we believed we could do something that was closer to our needs. We wanted a small framework with very basic support and a great epandability. This is why we created minimalism: it's what we needed.

If you think minimalism hits the right notes and you want to help, please jump to the Contribution section and send your love!

Minimalism Interfaces

Some of minimalism services are based on some common interfaces. These interfaces are implemented in services which offers different views on the same interface.

Please note that every installation of minimalism can only use one service implementing a minimalism interface. This means that should you like to use MySQL you won't be able to use any other service which implements minimalism-interface-sql.

Currently, the following interfaces have been created:

  • Sql: Interface to access data in database
  • User: Interface to define a project-specific user to be used in generic services
  • Mailer: Interface to send emails
  • Cache: Interface to cache data
  • Encrypter: Interface to manage simple data encryption

The interfaces do not offer functionalities, but they support services which implement the actual features

Minimalism Services

Installation

Docker

Contribution

If you think you can make minimalism better, we would love to hear from you! From bug fixes to proposed changes

All Changes Happen Through Pull Requests

Pull requests are the best way to propose changes. We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add some tests' example.
  3. If you've changed APIs, update the documentation.
  4. Issue that pull request!

Your interfaces and services

If you have developed any interface or service for minimalism, please do let us know and we will add it in the list of interfaces and services!

Build With

  • PHP 8.1
  • minimalism - minimal modular PHP MVC framework

Versioning

This project use Semantiv Versioning for its tags.

Author

License

This project is licensed under the MIT license - see the LICENSE.md file for details

License: MIT