https://github.com/pixelbrackets/pap-skeleton
https://github.com/pixelbrackets/pap-skeleton
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/pixelbrackets/pap-skeleton
- Owner: pixelbrackets
- Created: 2020-08-05T08:23:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-24T12:36:19.000Z (over 4 years ago)
- Last Synced: 2025-03-06T18:29:39.264Z (about 1 year ago)
- Homepage: https://gitlab.com/pixelbrackets/pap-skeleton
- Size: 2.93 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Build & Deployment Guide
This guide explains how to build and deploy the app.
The toolchain is set up with
[PAP](https://packagist.org/packages/pixelbrackets/pap).
## Requirements
- cURL, SSH & rsync to sync files
- Git to checkout package repositories
- PHP to run the script
- Composer to fetch required PHP packages
- SSH-Account on target stage(s) with read & write access,
and right to run cURL, rsync and PHP
```bash
apt-get install curl ssh rsync git php
wget https://getcomposer.org/composer.phar
```
## Installation
- Fetch required PHP packages running `./composer.phar install`
## Usage
- Run `./vendor/bin/pap` to see all available tasks
- Add `--help` to each task command, to see all available options
- Add `--simulate` to each task command, to run in dry-mode first
- Most tasks have a stage as target, passed with `--stage `
- If no stagename is passed, the name »local« is used as default - use this
for development on your local machine
1. Deploy to »live« stage
```bash
./vendor/bin/pap deploy --stage live
```
1. Deploy to »local« stage, used for development (default stage)
```bash
./vendor/bin/pap deploy
```
1. Sync to »local« stage (skips building assets)
```bash
./vendor/bin/pap sync
```
1. Sync to »local« stage automatically if anything changes in the
source directory (files changed, added or removed)
```bash
./vendor/bin/pap watch
```
1. Lint current build
```bash
./vendor/bin/pap lint
```
## Configuration
- All general settings and shared stages are configured in
the distribution file `pap.yml`
- All settings and stages may be overriden in a local environment file
`pap.local.yml`, which is ignored by Git
- Copy `pap.local.template.yml`, rename it to
`pap.local.yml` and change parameters as desired
- The documentation of all options is available in the
[PAP](https://packagist.org/packages/pixelbrackets/pap) package repository
## Update
- Update required PHP packages running `./composer.phar update`
- Commit the updated `composer.lock` file
## Upgrade
- Check the [PAP](https://packagist.org/packages/pixelbrackets/pap) package
repository for new releases, and the upgrade guide