valkyrjaio/application

View on GitHub
README.md

Summary

Maintainability
Test Coverage
<p align="center"><a href="https://valkyrja.io" target="_blank">
    <img src="https://i.imgur.com/bnZA2RT.png" width="400">
</a></p>
<p align="center">
    <a href="https://github.com/valkyrjaio/valkyrja/actions/workflows/php.yml"><img src="https://github.com/valkyrjaio/valkyrja/actions/workflows/php.yml/badge.svg" alt="Build Status"></a>
    <a href="https://packagist.org/packages/valkyrja/valkyrja"><img src="https://poser.pugx.org/valkyrja/valkyrja/v/stable.svg" alt="Latest Stable Version"></a>
    <a href="https://packagist.org/packages/valkyrja/valkyrja"><img src="https://poser.pugx.org/valkyrja/valkyrja/d/total.svg" alt="Total Downloads"></a>
    <a href="https://packagist.org/packages/valkyrja/valkyrja"><img src="https://poser.pugx.org/valkyrja/valkyrja/license.svg" alt="License"></a>
</p>
<p align="center">
    <!-- <a href="https://packagist.org/packages/valkyrja/valkyrja"><img src="https://poser.pugx.org/valkyrja/valkyrja/v/unstable" alt="Unstable Version"></a> -->
    <a href="https://scrutinizer-ci.com/g/valkyrjaio/valkyrja/"><img src="https://scrutinizer-ci.com/g/valkyrjaio/valkyrja/badges/quality-score.png?b=master" alt="Scrutinizer"></a>
    <a href="https://styleci.io/repos/304247237"><img src="https://styleci.io/repos/304247237/shield?branch=master&style=flat" alt="StyleCI"></a>
    <!-- <a href="https://coveralls.io/github/valkyrjaio/valkyrja?branch=master"><img src="https://coveralls.io/repos/github/valkyrjaio/valkyrja/badge.svg?branch=master" alt="Coverage Status" /></a> -->
    <a href="https://codecov.io/gh/valkyrjaio/valkyrja"><img src="https://codecov.io/gh/valkyrjaio/valkyrja/branch/master/graph/badge.svg" alt="Codecov" /></a>
    <a href="https://codeclimate.com/github/valkyrjaio/application/maintainability"><img src="https://api.codeclimate.com/v1/badges/064a68073fd300f90f7e/maintainability" /></a>
</p>

About Valkyrja
------------

> **Note:** This repository contains the application code of the Valkyrja framework.
> If you want to see the core source framework code, visit the [Valkyrja Framework repository][github framework repo].

[Valkyrja][Valkyrja] is a PHP framework for web and console applications.

Installation
------------

* [Install Valkyrja][install] with Composer (see [requirements details][requirements]).
* Valkyrja follows the [semantic versioning][semantic versioning] strictly.

Documentation
-------------

* Read the [Getting Started guide][getting started] if you are new to Valkyrja.
* Try the [Valkyrja Demo application][github demo app repo] to learn Valkyrja in practice.
* Master Valkyrja with the [Basics][basics], the [Modules][modules]
  and the [Advanced][advanced] docs.

Community
---------

* Follow us on [GitHub][github main].
* Read our [Code of Conduct][code of conduct]

Contributing
------------

Valkyrja is an Open Source, community-driven project.
Join us by [contributing code][contribute code] or reading our [contributing documentation][contributing].

Security Issues
---------------

If you discover a security vulnerability within Valkyrja, please follow our
[disclosure procedure][security vulnerabilities].

License
---------------

The Valkyrja framework is open-sourced software licensed under the [MIT license][MIT license].

[Valkyrja]: https://valkyrja.io

[github main]: https://github.com/valkyrjaio

[github framework repo]: https://github.com/valkyrjaio/valkyrja

[github demo app repo]: https://github.com/valkyrjaio/application

[docs]: https://github.com/valkyrjaio/valkyrja/docs

[getting started]: https://github.com/valkyrjaio/valkyrja/docs/getting-started

[install]: https://github.com/valkyrjaio/valkyrja/docs/getting-started/installation

[requirements]: https://github.com/valkyrjaio/valkyrja/docs/getting-started/requirements

[basics]: https://github.com/valkyrjaio/valkyrja/docs/basics

[best practices]: https://github.com/valkyrjaio/valkyrja/docs/basics/best-practices

[advanced]: https://github.com/valkyrjaio/valkyrja/docs/advanced

[modules]: https://github.com/valkyrjaio/valkyrja/docs/Modules

[contributing]: https://github.com/valkyrjaio/valkyrja/docs/contributing

[code of conduct]: https://github.com/valkyrjaio/valkyrja/docs/contributing/code-of-conduct

[contribute code]: https://github.com/valkyrjaio/valkyrja/docs/contributing/code

[security vulnerabilities]: https://github.com/valkyrjaio/valkyrja/docs/contributing/security-vulnerabilities

[semantic versioning]: https://semver.org/

[MIT license]: https://opensource.org/licenses/MIT