SproutCMS 3.1

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/

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

For older versions of PHP (5.5 through 7.2) use the Sprout 3.0 branch or update your hosting (recommended).

Requirements

• PHP 7.3 or later

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

• MySQL 5.7 or later, or MariaDB 10.3 or later

• Composer 2 or later

Installation

1. Download
2. Extract the ZIP file somewhere
3. Run composer install
4. Run composer serve
5. Browse to http://localhost:8080/
6. Follow the on-screen instructions

For a detailed installation walk-through see INSTALL.md

Deployment

SproutCMS runs natively with git deploy.

1. Set up your remote, e.g.

git remote add production "[email protected]:/apps/mynewapp"

2. Run the setup task

git deploy setup -r "production"

3. No need to run git deploy init as this has already been done

4. Push the code

git push production master

Development tools

To run unit tests, execute the following from the root directory:

$ composer test

To run NStrack, our namespace issue finder and fixer, run from the root directory, e.g.

$ composer nstrack

To add license blocks to recently added files, run the following from the root directory:

$ php tools/license_block/license_block.php