Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/uiii/processwire

Composer package for ProcessWire CMS installation
https://github.com/uiii/processwire

composer processwire

Last synced: 6 days ago
JSON representation

Composer package for ProcessWire CMS installation

Awesome Lists containing this project

README

        

# Composer package for ProcessWire CMS installation

[![Packagist](https://img.shields.io/packagist/v/uiii/processwire.svg)](https://packagist.org/packages/uiii/processwire)
[![Flattr](https://img.shields.io/badge/flattr-donate-yellow)](https://flattr.com/@uiii)
[![Paypal](https://img.shields.io/badge/paypal-donate-yellow)](https://paypal.me/richardjedlicka)

Using this package you can easily install ProcessWire to your project.
This works differenty from the official [processwire/processwire](https://packagist.org/packages/processwire/processwire) composer package,
where the official package just places the PW copy into `vendor/processwire/processwire`, this installs the PW directly
to the project's root (thanks to [uiii/pw-core](https://github.com/uiii/pw-core)).

## Why all this?
It is not easy (if event possible) to run PW instance with `wire` and `site` folders in different locations.
So if the PW is under `vendor` directory your `site` folder must too.

This package solves this by changing the PW install location to project's root next to your `site` folder.

## Usage

Just set the required PW version as composer dependency:

```
composer require uiii/processwire:
```

> #### Completely new installation
> If you haven't set up the PW yet (`site/assets/installed.php` doesn't exist), all files required for initial PW setup will be installed. Afterwards continue the setup in the browser.

> #### Already existing `site` folder
> If you have set up PW before and you have your `site` folder already present, only the files required for running the site will be installed (`wire`, `index.php`, `.htaccess`).
>
> Old `index.php` and `.htaccess` will be backuped with `.bak` extension

Now when you deploy your site, install all your dependencies (PW included) with `composer install`.

> **NOTE:** It is reasonable to config your VCS to ignore the `wire` directory.

### Updating existing installation

Updating is easy, just require new version: `composer require uiii/processwire:`

### Set different install path

By default PW is installed in the root directory (next to the `composer.json` file). You change the install path by setting the `pw-install-path` extra parameter in `composer.json`:

```json
"extra": {
"pw-install-path": "path/to/install"
}
```