README

This is the official installer to start new projects based on the Bricks platform by 20steps.

Installing the installer

This step is only needed the first time you use the installer:

Linux and Mac OS X

$ sudo curl -LsS https://bricks.20steps.de/downloads/installer -o /usr/local/bin/bricks
$ sudo chmod a+x /usr/local/bin/bricks

Windows

c:\> php -r "file_put_contents('bricks', file_get_contents('https://bricks.20steps.de/downloads/installer'));"

Move the downloaded bricks file to your projects directory and execute it as follows:

c:\> php bricks

If you prefer to create a global bricks command, execute the following:

c:\> (echo @ECHO OFF & echo php "%~dp0bricks" %*) > bricks.bat

Then, move both files (bricks and bricks.bat) to any location included in your execution path. Now you can run the bricks command anywhere on your system.

Installing without the Installer

If you can't use the Bricks Installer for any reason, you can create Bricks applications with Composer, the dependency manager used by modern PHP applications.

If you don't have Composer installed in your computer, start by installing Composer globally.

Then, execute the create-project command to create a new Bricks application based on its latest stable version:

composer create-project 20steps/bricks-platform-standard-edition my_project_name

To create a new Bricks application based on the latest non-stable version execute:

composer create-project 20steps/bricks-platform-standard-edition my_project_name dev-master

Using the installer

1. Start a new project with the latest stable Bricks version

Execute the new command and provide the name of your project as the only argument:

# Linux, Mac OS X
$ bricks new my_project

# Windows
c:\> php bricks new my_project

2. Start a new project with the latest Bricks LTS (Long Term Support) version

Execute the new command and provide the name of your project as the first argument and lts as the second argument. The installer will automatically select the most recent LTS (Long Term Support) version available:

# Linux, Mac OS X
$ bricks new my_project lts

# Windows
c:\> php bricks new my_project lts

3. Start a new project based on a specific Bricks branch

Execute the new command and provide the name of your project as the first argument and the branch number as the second argument. The installer will automatically select the most recent version available for the given branch:

# Linux, Mac OS X
$ bricks new my_project 2.8

# Windows
c:\> php bricks new my_project 2.8

4. Start a new project based on a specific Bricks version

Execute the new command and provide the name of your project as the first argument and the exact Bricks version as the second argument:

# Linux, Mac OS X
$ bricks new my_project 2.8.1

# Windows
c:\> php bricks new my_project 2.8.1

5. Install the Bricks demo application

The Bricks Demo is a reference application developed using the official Bricks Best Practices:

# Linux, Mac OS X
$ bricks demo

# Windows
c:\> php bricks demo

Updating the installer

New versions of the Bricks Installer are released regularly. To update your installer version, execute the following command:

# Linux, Mac OS X
$ bricks self-update

# Windows
c:\> php bricks self-update

NOTE

If your system requires the use of a proxy server to download contents, the installer tries to guess the best proxy settings from the HTTP_PROXY and http_proxy environment variables. Make sure any of them is set before executing the Bricks Installer.

Troubleshooting

SSL and certificates issues on Windows systems

If you experience any error related with SSL or security certificates when using the Bricks Installer on Windows systems:

Check that the OpenSSL extension is enabled in your php.ini configuration:

; make sure that the following line is uncommented
extension=php_openssl.dll

Check that the path to the file that contains the security certificates exists and is defined in php.ini:

openssl.cafile=C:/path/to/cacert.pem

If you can't locate the cacert.pem file anywhere on your system, you can safely download it from the official website of the cURL project: http://curl.haxx.se/ca/cacert.pem

Author

Helmut Hoffer von Ankershoffen (hhva@20steps.de)

20steps / bricks-installer

Maintainers

Details