README

SproutCMS is a flexible and feature rich cms and application framework, developed in PHP, designed to enable quick and agile custom development. SproutCMS was built to reward innovation and encourage developers to produce complex applications.

It is built by developers, for developers.

Website: http://getsproutcms.com/

Development docs: http://docs.getsproutcms.com/docs/

User manual: http://docs.getsproutcms.com/manual/

Class reference: http://docs.getsproutcms.com/reference/

Requirements

• PHP 8.2 or later

• A web server, e.g. Apache or nginx

• MySQL 8.0 or later, or MariaDB 10.3 or later

• Composer 2 or later

Getting started

1. Run composer create-project sproutcms/site
2. Run composer serve
3. Browse to http://localhost:8080/

This is a quick start example. For a detailed installation walk-through see INSTALL.md

Development tools

To run unit tests:

# Run unit tests
composer test

# To run phpstan
composer analyse

# symlink co-located dependencies
composer patch-locals

# add license blocks
php tools/license_block/license_block.php

Publishing

(for contributors)

To publish a new version simply create a git tag with the next appropriate version. This is then automatically pushed to packagist.libfun.net via a web hook.

We've created a script to automate this:

./tools/publish.sh v4.x.x "My new changes"

For example, given the last version (from git log) is v3.2.10 then tag and push v3.2.11.

Please be careful and don't publish untested code. Keep your messy business in a branch and require it into your projects using the dev- prefixes.

Such as:

composer require sproutcms/cms:dev-my-broken-branch

Or use the composer patch-locals script to symlink the dependency while locally building your site.