Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/spiral-packages/aula


https://github.com/spiral-packages/aula

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# This is my package aula

[![PHP](https://img.shields.io/packagist/php-v/spiral/aula.svg?style=flat-square)](https://packagist.org/packages/spiral/aula)
[![Latest Version on Packagist](https://img.shields.io/packagist/v/spiral/aula.svg?style=flat-square)](https://packagist.org/packages/spiral/aula)
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/spiral/aula/run-tests?label=tests&style=flat-square)](https://github.com/spiral/aula/actions?query=workflow%3Arun-tests+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/spiral/aula.svg?style=flat-square)](https://packagist.org/packages/spiral/aula)

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

## Requirements

Make sure that your server is configured with following PHP version and extensions:

- PHP 8.0+
- Spiral framework 2.9+


## Installation

You can install the package via composer:

```bash
composer require spiral/aula
```

After package install you need to register bootloader from the package.

```php
protected const LOAD = [
// ...
\Spiral\Aula\Bootloader\AulaBootloader::class,
];
```

> Note: if you are using [`spiral-packages/discoverer`](https://github.com/spiral-packages/discoverer),
> you don't need to register bootloader by yourself.

## Testing

```bash
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Kirill](https://github.com/kastahov)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.