Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 2.32 KB

README.md

File metadata and controls

82 lines (58 loc) · 2.32 KB

containers

Creative Commons (CC) containers images (primarily for use by CC application container images).

Images

Development

Local development uses Docker Compose and a suite of static analysis tools.

Dependencies

  1. Install Docker (Get Docker | Docker Docs)
  2. Install addititional dependencies macOS installation example:
    brew install hadolint prek railway rsync shellcheck
    1. Install hadolint (Install - hadolint/hadolint)
    2. Install prek (Installation - j178/prek)
    3. Install Railway CLI (Installing - CLI | Railway Docs)
    4. Install Rsync (rsync download)
    5. Install shellcheck (Installing - koalaman/shellcheck)

Setup

  1. Prepare and install prek Git hooks:
    prek install --prepare-hooks
  2. Create the enviornment .env file by copying .env.example:
    cp .env.example .env
  3. Update .env to ensure all variable have appropriate values.
  4. Build Docker Compose services:
    docker-compose build

Static analysis

Analysis on git commit is configure in Setup, step 1, above.

Prek can be invoked manually:

prek run --show-diff-on-failure --color=always --all-files

License

CC0 1.0 Universal (CC0 1.0) Public Domain Dedication button

LICENSE: The contents of this repository are dedicated to the public domain under the CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.