https://github.com/chapter-three/courtyard-artifact

https://github.com/chapter-three/courtyard-artifact

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/chapter-three/courtyard-artifact
• Owner: chapter-three
• Created: 2020-01-28T08:45:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-05T06:53:19.000Z (about 5 years ago)
• Last Synced: 2025-01-18T06:27:37.905Z (3 months ago)
• Language: HTML
• Size: 12.9 MB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Courtyard Artifact

This is a consumable artifact for the [Courtyard Pattern Library](https://github.com/Exygy/courtyard).

It includes tooling to regenerate from the Pattern Lab and sync to this artifact.

## Tooling

### Lando

Lando is used for easy PHP and Node environments and is configured with the following commands:

```yaml

clone:

  description: Clone Courtyard to build an artifact, or for development. `lando clone`

  ...

artifact:

  description: (Re)build the artifact.

  ...

patch:

  description: Apply patches from /patches to couryard.

  ...

sync:

  description: Sync built assets to artifact.

  ...

```

### Instructions

#### To update the pattern library:

 - `clone [this repo]`

 - `cd [this repo directory]`

 - `lando start`

 - `lando clone -b [branch to checkout]` - At this time, `development` branch gives the best results. Please update this if that changes.

 - `lando patch` - will apply patches from `/patches`. This currently fixes the Courtyard composer.json and gulpfile.js files to allow installation with separate docker containers for PHP and Nodejs.

 - `lando artifact` - will install and build the pattern library as well as sync it to the `/public` directory of this artifact.

See [Courtyard's Composer Install Wizard Docs](https://github.com/Exygy/courtyard#composer-install-wizard) for the answers to the prompts during install.

See the [Courtyard Repository](https://github.com/Exygy/courtyard) for additional information and troubleshooting.

#### Update the composer package:

 - Testing workflow TBD

 - After a new build is tested and verified commit the changes to this courtyard-artifact repo on `master` branch.

 - Add a new version tag: x.y.z

 - Push master and tag to Github

 - Packagist should be updated automatically.

Your artifact can now be installed via `composer require /courtyard-artifact`.