PHP HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Spress - PHP Static site generator

Build Status Build status Scrutinizer Code Quality Code Coverage SensioLabsInsight

Spress is a static site generator built with Symfony components.

License: MIT.

Requirements

  • Linux, Unix, Mac OS X or Windows.
  • PHP >= 5.6.
  • Composer.

Community

Discuss and share your opinions in Gitter chat:

Gitter

Contributing

When Contributing code to Spress, you must follow its coding standards. Spress follows PSR-2 coding style.

Keep in mind the golden rule: Imitate the existing Spress code.

Pull Requests

  • Fork the Spress repository.
  • Create a new branch for each feature or improvement.
  • New features: Send a pull request from each feature branch to master branch.
  • Fixes: Send a pull request to 2.1 branch.

Unit testing

All pull requests must be accompanied by passing unit tests. Spress uses phpunit for testing.

How to make spress.phar

We are using Box Project for generating the .phar file.

You may download Box:

$ curl -LSs https://box-project.github.io/box2/installer.php | php

Next:

$ cd spress-folder
$ box build

Unit tests

Spress uses PHPUnit >= 5.7. You can run the unit tests with the following command:

$ cd your-path
$ phpunit