PHP Static site generator
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin Dropped the support for PHP 5.5. The minimum version is 5.6 Mar 19, 2017
src
tests Skipped test until get Symfony 4.1 Jun 7, 2018
.gitignore
.travis.yml Fixed PHPUnit in file .travis.yml Sep 7, 2018
CHANGELOG.md
LICENSE Updated the year Jun 10, 2017
README.md Updated PHP minimum version to 7.2 Sep 7, 2018
appveyor.yml Updated Symfony component to 4.1 Sep 7, 2018
box.json Deleted a finder's criteria that throws a few warnings at PackageMana… Oct 31, 2016
build.xml Fixed a typo May 21, 2016
composer.json Updated Symfony component to 4.1 Sep 7, 2018
composer.lock Updated Symfony component to 4.1 Sep 7, 2018
phpunit.xml.dist Excluded "net" group Nov 9, 2016

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 +7.2.
  • 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