Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oanhnn/example-deployer-slim

Example project for deployment PHP project (Slim Framwork) by Deployer
https://github.com/oanhnn/example-deployer-slim

deploy-tool deployer deployment

Last synced: 3 days ago
JSON representation

Example project for deployment PHP project (Slim Framwork) by Deployer

Awesome Lists containing this project

README

        

# Introduction

[![Join the chat at https://gitter.im/oanhnn/deployer-example](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/oanhnn/deployer-example?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

An example for use [Deployer](http://deployer.org) to deployment PHP project.
In this example, i'm will deploy a project using [Slim framework](https://github.com/slimphp/Slim) follow my [slim-skeleton](https://github.com/oanhnn/slim-skeleton)

See [http://deployer.org](http://deployer.org) for more information and documentation about Deployer.

# Requirements

* PHP 5.6.0 and up.

That's all!

> If PHP 5.4.x or 5.5.x, please using branch 3.x (using Deployer 3.x)

You can install [ssh2 extension](http://php.net/manual/en/book.ssh2.php) to speedup deployment process and
enable [sockets](http://php.net/manual/en/book.sockets.php) for parallel deployment.

# Installation

Clone with `git` and run `composer install`

```shell
$ git clone [email protected]:oanhnn/deployer-example.git
$ cd
$ composer install
```

or using [`composer`](http://getcomposer.org)

```shell
$ composer create-project oanhnn/deployer-example
```

# Usage

> In this example using forward agent feature, to run it, please [enable `ssh` forward agent](https://github.com/oanhnn/deployer-example/blob/master/docs/enable-feature-ssh-forward-agent.md) the first.
> If using ssh2 extension, please require package `"herzult/php-ssh": "~1.0"` and add line `set('ssh_type', 'ext-ssh2');` to `deploy.php` file before deployment.
> If using native ssh client, please add line `set('ssh_type', 'native');` to `deploy.php` file before deployment.

Customize `stage/dev.php` or make a copy and write your own stages.

First deployment:
```shell
$ bin/dep deploy:configure
$ bin/dep deploy
```

Next deployments:
```shell
$ bin/dep deploy
```

Using options `-vvv` for debug
```shell
$ bin/dep deploy -vvv
```

Contributing
------------
All code contributions must go through a pull request and approved by a core developer before being merged.
This is to ensure proper review of all the code.

Fork the project, create a feature branch, and send a pull request.

To ensure a consistent code base, you should make sure the code follows
the [PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md).

If you would like to help take a look at the [list of issues](https://github.com/oanhnn/deployer-example/issues).

License
-------
This project is released under the MIT License.
Copyright © 2015-2017 Oanh Nguyen.
Please see [License File](LICENSE.md) for more information.