joy v0.3.3

The Jake and trOY devops-y utility

Built With

• Coffee: A good source of C8H10N4O2
• Git 2.17.1
• Gulp
• NodeJS 11.1.0
• NPM 6.4.1
• Oh-My-Zsh on Bash on Ubuntu on Windows Subsystem for Linux
• Visual Studio Code 1.29.1 on Windows 10

Required Runtime Dependencies

• NodeJs: Everything else should come in from npm i.

Required Development Dependencies

• Git
• A code editor

Installation

npx joy {command} [options]

Usage

Once installed you can interact with Joy by simply typing npx joy {command} [param1] [param2] [param3] [etc].

Configure a new Joy project

Instructions here to explain how to use joy init and what to change in the config.env file.

To view Swagger docs and send Slack notifications to the #build channel ensure that the project config.env has the following two lines. If you're running your API from a Docker container then substitute the proper URI. The Slack webhook URL is masked so we don't accidentally copy/paste and spam the wrong client's channel.

SWAGGER_FILE_URI=http://localhost:10010/swagger
SLACK_INCOMING_WEBHOOK_URL https://hooks.slack.com/services/T7KSWL4E9/BGL0HSVB2/************************

Joy Commands

Commands are grouped into nouns such as:

• build
• test
• push
• etc

Notes for .joy/config.env

tbd

Developer Installation and Setup

1. Git clone
2. Some other stuff

Debugging from Visual Studio Code

Create an appropriate configuration in ./vscode/launch.json

{
  "version": "0.2.0",
  "configurations": [{
    "type": "node",
    "request": "launch",
    "name": "Debug joy.js",
    "program": "${workspaceFolder}/joy/joy.js",
    "useWSL": true,
    "args": [
      "Joy",
      "args",
      "to",
      "debug",
      "here"
    ]
  }]
}

Note that the example above sets "useWSL": true. This is necessary if running on Windows with Node and the majority of the development tool chain installed into the Windows Subsystem for Linux.

Tips and Tricks

tbd

Change Log

v0.3.3 Another Refactor (2019-08-22)

• Switched to Caporal for managing CLI args
• Moved away from .sh to .js (aka Shell to NodeJS)
• Static site generator code is more robust

Known Issues

• Most commands, except joy build static are not working following the refactorig due to some pathing issues that will be resolved in the next release.

v0.3.2 A11Y (2019-07-26)

Added new test a11y command for basic accessibility testing

v0.3.1 Bug

v0.3.0 NPX'fied (2019-05-16)

Changed installation strategy from SSH and Git based to NPM/NPX. Also improved the basic help text for each command.

v0.2.0 Local environment settings (2019-05-07)

Local .joy folders gain a new config.local.env file. This file is added once then .gitignored so that each installation can maintain its own local settings. Settings that include local path to secrets volume, environment type (e.g. dev, stage or prod), etc.

v0.1.0 Really early PoC (2019-04-05)

First commit to Github.