Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sikessem/framework

⚡️ The @Sikessem framework.
https://github.com/sikessem/framework

composer framework php sikessem

Last synced: about 1 month ago
JSON representation

⚡️ The @Sikessem framework.

Awesome Lists containing this project

README

        

[![sikessem-logo]][sikessem-link]


[![php-icon]][php-link]
[![packagist-version-icon]][packagist-version-link]
[![packagist-download-icon]][packagist-download-link]
[![license-icon]][license-link]
[![enabled-icon]][enabled-link]
[![actions-icon]][actions-link]
[![pr-icon]][pr-link]
[![twitter-icon]][twitter-link]

[sikessem-logo]: https://github.com/sikessem/art/blob/HEAD/images/sikessem.svg
[sikessem-link]: https://github.com/sikessem "Sikessem"

[php-icon]: https://img.shields.io/badge/PHP-ccc.svg?style=flat&logo=php
[php-link]: https://github.com/sikessem/framework/search?l=php "PHP code"

[packagist-version-icon]: https://img.shields.io/packagist/v/sikessem/framework
[packagist-version-link]: https://packagist.org/packages/sikessem/framework "Framework Releases"

[packagist-download-icon]: https://img.shields.io/packagist/dt/sikessem/framework
[packagist-download-link]: https://packagist.org/packages/sikessem/framework "Framework Downloads"

[enabled-icon]: https://img.shields.io/badge/Framework-enabled-brightgreen.svg?style=flat
[enabled-link]: https://github.com/sikessem/framework "Framework enabled"

[actions-icon]: https://github.com/sikessem/framework/workflows/CI/badge.svg
[actions-link]: https://github.com/sikessem/framework/actions "Framework status"

[pr-icon]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?color=brightgreen
[pr-link]: [contrib-link] "PRs welcome!"

[twitter-icon]: https://img.shields.io/twitter/follow/sikessem_tweets.svg?label=@sikessem_tweets
[twitter-link]: https://twitter.com/intent/follow?screen_name=sikessem_tweets "Ping Sikessem"

[license-icon]: https://img.shields.io/badge/license-MIT-blue.svg
[license-link]: https://github.com/sikessem/framework/blob/HEAD/LICENSE "Framework License"
[conduct-link]: https://github.com/sikessem/.github/blob/HEAD/CODE_OF_CONDUCT.md
[contrib-link]: https://github.com/sikessem/.github/blob/HEAD/CONTRIBUTING.md
[discuss-link]: https://github.com/orgs/sikessem/discussions

***

# The Sikessem Framework

This framework is a Laravel customization for the [sikessem/skeleton](https://packagist.org/packages/sikessem/skeleton).

## 🔖 Contents

- [The Sikessem Framework](#the-sikessem-framework)
- [🔖 Contents](#-contents)
- [📋 Requirements](#-requirements)
- [⚡️ Installation](#️-installation)
- [👏 Contribution](#-contribution)
- [Code of Conduct](#code-of-conduct)
- [👥 Contributing Guide](#-contributing-guide)
- [🔒️ Good First Issues](#️-good-first-issues)
- [💬 Discussions](#-discussions)
- [🔐 Security Reports](#-security-reports)

## 📋 Requirements

> - **Requires [PHP 8.2+](https://php.net/releases/)** (at least 8.2.20 recommended to avoid potential bugs).
> - **Requires [Composer v2+](https://getcomposer.org/)** to manage PHP dependencies.

## ⚡️ Installation

Install [Framework](https://packagist.org/packages/sikessem/framework) using [Composer](https://getcomposer.org/):

- By adding the `sikessem/framework` dependency to your `composer.json` file:

```json
{
"require" : {
"sikessem/framework": "^0.6"
}
}
```

- Or by including the dependency:

```bash
composer require sikessem/framework
```

## 👏 Contribution

The main purpose of this repository is to continue evolving Sikessem. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Sikessem.

### [Code of Conduct][conduct-link]

Sikessem has adopted a Code of Conduct that we expect project participants to adhere to.
Please read the [full text][conduct-link] so that you can understand what actions will and will not be tolerated.

### 👥 [Contributing Guide][contrib-link]

Read our [**Contributing Guide**][contrib-link] to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Sikessem.

### 🔒️ Good First Issues

We have a list of [good first issues][gfi] that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

[gfi]: https://github.com/sikessem/framework/labels/good%20first%20issue

### 💬 Discussions

Larger discussions and proposals are discussed in [**sikessem/community**][discuss-link].

## 🔐 Security Reports

If you discover a security vulnerability within [Sikessem](https://sikessem.com), please email [Sigui Kessé Emmanuel](https://github.com/siguici) at [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.

***

Made with ❤︎ by @siguici.