Skip to content
This repository has been archived by the owner on Dec 6, 2021. It is now read-only.

Latest commit

 

History

History
56 lines (37 loc) · 2.1 KB

README.md

File metadata and controls

56 lines (37 loc) · 2.1 KB

Croaker

Build Status Maintainability Test Coverage

Croaker is an open source PHP project management application built on the Symfony Framework.

Croaker is currently in initial development. As such, some functionality, documentation and tests may be missing.

While in initial development, the master branch contains all project files. Once Croaker is in a stable state for initial release, the master branch will no longer include development files. I.e. phpunit.xml, .docker, Makefile, etc...

Getting Started

Croaker is intended to be fully compliant with PSR-1, PSR-2, & PSR-4

Prerequisites

  • PHP 7.4+

Documentation

More extensive documentation on Helpers is to be released soon. In the meantime, all of the methods and properties are well documented within the code base.

Development

Docker containers are provided for development purposes. To use the containers, copy .docker/xdebug-DIST.ini to .docker/php-cli/xdebug.ini and update the respective values.

A Makefile is provided to assist in managing the containers as well as running phpunit, php-cs, and phpstan within the workspace container.

From the project root directory, typing make on the command line will print available make commands.

Croaker is being developed on Debian Buster and as such any associated docker, make, etc. files have not been tested in other environments.

Authors

Source available on GitHub

For questions, comments, or rant's, drop me a line at

jr (at) geeshoe (dot) com