Skip to content

Sikessem/blade-components

Repository files navigation

sikessem-logo


php-icon packagist-version-icon packagist-download-icon license-icon enabled-icon actions-icon pr-icon twitter-icon


πŸ“¦οΈ Sikessem Skeleton

Create a new Sikessem project based on this template.

πŸ”– Contents

πŸ“‹ Requirements

  • Requires PHP 8.1+ (at least 8.1.19 recommended to avoid potential bugs).
  • Requires Composer v2+ to manage PHP dependencies.

πŸŽ‰ Getting Started

⚑️ Installation

Install Skeleton using Composer:

  • By adding the sikessem/skeleton dependency to your composer.json file:
{
    "require" : {
        "sikessem/skeleton": "self.version"
    }
}
  • Or by including the dependency:
composer require sikessem/skeleton --no-dev
  • Or by creating a new project from the template:
create-project sikessem/skeleton --prefer-source skeleton

πŸ§‘β€πŸ’» Usage

<?php

use Sikessem\Skeleton\Program;

$vendor_dir = __DIR__.'/vendor'; // Replace it by your vendor directory

include_once $vendor_dir.'/autoload.php';

Program::main(); // Print "Hello World!"

πŸ§ͺ Testing and debugging

🧹 Keep a modern codebase with Pint:

composer lint

βš—οΈ Run static analysis:

  • Using PHPStan:
composer analyse
  • Using Psalm:
composer inspect

βœ… Run unit tests using PEST

composer test

πŸ› Check all code bugs:

composer debug

πŸš€ Fix the entire code:

composer fix

πŸ“– Documentation

The full documentation for the Sikessem Skeleton can be found on this address.

πŸ‘ 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.

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

Read our Contributing Guide 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 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.

πŸ’¬ Discussions

Larger discussions and proposals are discussed in Sikessem's GitHub discussions.

πŸ” Security Reports

If you discover a security vulnerability within Sikessem, please email SIGUI KessΓ© Emmanuel at [email protected]. All security vulnerabilities will be promptly addressed.

πŸ“„ License

The Sikessem Skeleton is open-sourced software licensed under the MIT License - see the LICENSE file for details.


Made with ❀︎ by @siguici.