Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 3.43 KB

README.md

File metadata and controls

84 lines (58 loc) · 3.43 KB

Bolt

Sophisticated, lightweight & simple CMS, homepage: Bolt.cm

Bolt is a tool for Content Management, which strives to be as simple and straightforward as possible. It is quick to set up, easy to configure, uses elegant templates, and above all: It's a joy to use. Bolt is created using modern open source libraries, and is best suited to build sites in HTML5 with modern markup.

From a technical perspective: Bolt is written in PHP, and uses either SQLite, MySQL or PostgreSQL as a database. It's built upon the Silex framework together with a number of Symfony components and other libraries. Bolt is released under the open source MIT-license.

Current build status and code quality

Build Status

For continously inspecting our code, we use Scrutinizer CI. You can find all runs on our code base here.

Installation

Because Bolt is now on Packagist, installing is even more easy by using Composer.

Installing composer can be done from the command line like so:

$ curl -s http://getcomposer.org/installer | php

After that, you can install Bolt in one line:

$ php composer.phar create-project bolt/bolt demo/ 1.0.0

In the above command, demo/ is the relative path where you want Bolt to be installed. 1.0.0 is the version number you'd like to install. For available version numbers, check the tags in the Github repo or on the Packagist page.

You're now good to go.

More detailed instructions can be found in the Setup section in the documentation.

Reporting issues

When you run into an issue, be sure to provide some details on the issue. Please include with your report:

  • the (example) input;
  • the output you expected;
  • the output actually produced.

This way we can reproduce your issue, turn it into a test and prevent the issue from occurring in future versions.

Unit tests

For running unit tests you need phpunit

After installing, you can run the unit test suite by running

$ phpunit -c app/

This can now also be done by using app/nut:

$ php app/nut tests:run

Extensions

The available extensions that ship with Bolt are going to be separated once we have a separate extension repository. We're planning for a neat way to install and manage extensions. However, this is not ready yet. Therefor, we temporarily list available third party extensions on this page.

Currently, these are the third party extensions we're aware of:

The extensions can be placed in the app/extensions folder. Learn more about writing extensions from our docs