README.md

Orchestra

Orchestra is a meta package for defining, scaffolding, rapidly deploying, and re-deploying Symphony CMS builds.

• Installation
• Basic Usage
• About
  • Requirements
  • Dependencies
• Documentation
• Support
• Contributing
• License

Installation

Pre-compiled

$ curl -sSL https://github.com/pointybeard/orchestra/releases/download/1.0.0/orchestra.phar > orchestra.phar
$ sudo mv orchestra.phar /usr/local/sbin/orchestra
$ sudo chmod 0755 /usr/local/sbin/orchestra

This will download the pre-compiled Orchestra binary and move it to /usr/local/sbin.

From Source

$ git clone --depth 1 https://github.com/pointybeard/orchestra.git
$ cd orchestra
$ composer update \
    --no-cache \
    --optimize-autoloader \
    --no-dev
$ make && sudo make install

This will install Orchestra to /usr/local/sbin. Use target=/some/path to specify a different destination for the Orchestra binary, e.g. make install target=~/bin/orchestra

Basic Usage

1. Initialise a new Orchestra project by running

$ orchestra init myproject

The name of your project (in this example, "myproject") is optional. If ommitted, the name of the parent folder will be used instead.

2. Update .orchestra/build.json with your project specific details (see, Customising your Build)
3. Run the following command to build and deploy your project

$ orchestra build

Tip: Use --help for details on options and flags.

4. Create virtual hosts in Apache that point to www/admin (see, Navigating to the Admin) and www/www (see, Viewing the Frontend and Creating Sub-projects).

About

Requirements

• Orchestra works with PHP 7.3 or above.
• Composer, which is used to install dependencies

Dependencies

Orchestra depends on the following Composer dev libraries:

• squizlabs/php_codesniffer
• friendsofphp/php-cs-fixer
• damianopetrungaro/php-commitizen
• php-parallel-lint/php-parallel-lint

Documentation

Documentation is coming soon!

Read the full documentation here.

Support

If you believe you have found a bug, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.

Contributing

We encourage you to contribute to this project. Please check out the Contributing to this project documentation for guidelines about how to get involved.

Author

• Alannah Kearney - hi@alannahkearney.com - http://twitter.com/pointybeard
• See also the list of contributors who participated in this project

License

"Orchestra" is released under the MIT License. See LICENCE.md for full copyright and license information.