Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.06 KB

CONTRIBUTE.md

File metadata and controls

42 lines (26 loc) · 1.06 KB

Contribute

This project is a template and a real playground project at the same time.

Install

Requirement:

First you'll have to install the root and playground dependencies :

$ bun install -y
$ cd playground && bun install -y

Run things

  • cd playground && bun run dev for the playground project
  • bun run storybook:start for Storybook
  • bun run cypress:open for Cypress
  • bun run jest:start for Jest

Test the Github Actions

To ease a bit the Github Workflow debugging, feel free to use act like so:

$ act pull_request

Then create a PR and check the tests on Github.

Create new template

When the actual files are not good enough for being copied, you must duplicate them using the pattern FILENAME.template.EXT. Then update the generator in .bin/index.js.

Update the generator

For the moment, all the generator logic is contained inside the .bin/index.js.