README

Athenaeum

Athenaeum is a mono repository; a collection of various packages. The majority are based on well known components, such as those offered by Laravel. Some of the key packages that are offered by Athenaeum, are the following:

Config

A configuration loader, supporting *.ini, *.json, *.php, *.yml and *.toml.

Core

A custom Laravel Application implementation, intended to be integrated into legacy applications.

Circuits

A Circuit Breaker to encapsulate failure prevention logic.

Dto

Data Transfer Object abstraction.

Http Clients

Http Client wrapper, with a Manager able to handle multiple "profiles".

Support

Aware-of Helpers for Laravel and DTOs.

Not a Framework

Despite the amount of packages, you should not mistake Athenaeum for a framework. It is not the intent nor purpose of this mono repository to act as a framework. The majority of the offered packages, are merely helpers and utilities.

How to install

composer require aedart/athenaeum

Official Documentation

Please read the official documentation for additional information.

Contribution

Have you found a defect ( bug or design flaw ), or do you wish improvements? In the following sections, you might find some useful information on how you can help this project. In any case, I thank you for taking the time to help me improve this project's deliverables and overall quality.

Bug Report

If you are convinced that you have found a bug, then at the very least you should create a new issue. In that given issue, you should as a minimum describe the following;

• Where is the defect located
• A good, short and precise description of the defect (Why is it a defect)
• How to replicate the defect
• (A possible solution for how to resolve the defect)

When time permits it, I will review your issue and take action upon it.

Fork, code and send pull-request

A good and well written bug report can help me a lot. Nevertheless, if you can or wish to resolve the defect by yourself, here is how you can do so;

• Fork this project
• Create a new local development branch for the given defect-fix
• Write your code / changes
• Create executable test-cases (prove that your changes are solid!)
• Commit and push your changes to your fork-repository
• Send a pull-request with your changes
• Drink a Beer - you earned it :)

As soon as I receive the pull-request (and have time for it), I will review your changes and merge them into this project. If not, I will inform you why I choose not to.

Versioning

This package follows Semantic Versioning 2.0.0

License

BSD-3-Clause, Read the LICENSE file included in this package