@skills17/competitor-readme

skills17/cypress-helpers

This package provides a framework to write test projects for skills related competitions. It includes:

• Components to render competitor instructions and ask competitors to sign up
• Commands
  • start or build the test project with live refresh competitor-readme
  • generate PDF documents of each task module convert-to-pdf
• ... and more

Table of contents

• Installation
• Usage
• License

Installation

Requirements:

• Node 16 or greater

To install this package, simply run the following command:

npm install @skills17/competitor-readme

Alternatively, you can simply run the following command to serve the readme without installing:

npx @skills17/competitor-readme

It is suggested to add the following npm scripts:

  "scripts": {
    "start": "competitor-readme",
    "build": "competitor-readme --build dist",
    "pdf": "convert-to-pdf --skip-build"
  },

This will provide the following commands:

• npm start - Start the live-refresh server (useful for writing the readme)
• npm run build - Creates a production build
• npm run pdf - Creates a PDF per module

Usage

A championship.yaml file needs to be created that contains some information about the championship. It should be placed in the root folder of your project, next to the package.json file.

See the @skills17/competitor-readme/types TypeScript declarations for a detailed description of all available properties in the championship.yaml file.

CLI

As seen in the installation instructions, the competitor-readme command is available.

Running this command will start a development server with live refresh.

License

MIT