SproutCMS: content management and framework
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
deploy
documentation
src
tools
.gitignore
.htaccess
.nstrack.php
.travis.yml
INSTALL.md
LICENSE
README.md
icon.png
nginx_sprout.conf
phpunit.xml.dist

README.md

SproutCMS 3

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

Requirements

  • PHP 5.5 or later

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

  • MySQL 5.1 or later

Installation

  1. Download
  2. Extract the ZIP file somewhere
  3. Load up that directory in a web browser, and browse to / (e.g. http://localhost:8080/)
  4. 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 "user@example.com:/apps/mynewapp"
  1. Run the setup task
git deploy setup -r "production"
  1. No need to run git deploy init as this has already been done

  2. Push the code

git push production master

Development tools

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

$ phpunit

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

$ nstrack

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

$ php tools/license_block/license_block.php