vivephp / skeleton
π¦οΈ Vive library builder template.
Requires
- php: ^8.1|^8.2
Requires (Dev)
- sikessem/devtools: ^0.x-dev
README
π¦οΈ Sigui Skeleton
Create a new @siguici 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
Use this template or create a new [Vive][vive-link] library via the Composer create-project
command (recommended):
composer create-project vivephp/skeleton --prefer-source my-lib
π§βπ» Usage
<?php use Sigui\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 Vive Skeleton can be found on this address.
π Contribution
The main purpose of this repository is to continue evolving Vive. 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 Vive.
π· Code of Conduct
Vive 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.
π₯ Contributing Guide
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 Vive.
ποΈ 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 Vive's GitHub discussions.
π Security Reports
If you discover a security vulnerability within [Vive][vive-link], please email SIGUI KessΓ© Emmanuel at contact@sigui.ci. All security vulnerabilities will be promptly addressed.
π License
The Vive Skeleton is open-sourced software licensed under the MIT License - see the LICENSE file for details.
Made with β€οΈ by @siguici.