Monorepo template

Monorepo template for Javascript projects.

Usage (remove this section)

Features

• Github workflows, templates, Code of Conduct, Contributing guidelines, Security Policy, Dependabot config, Codeowners and license.
• Dev container for Github Codespaces
• JS setup with biome, depcheck, typescript, typedoc, mocha and playwright-test.
• Documentation generated with typedoc and published with Github pages.
• Changelog, versioning and release management with Release Please.
• Optional pre-commit hooks with lint-staged and simple-git-hooks.
• VS Code settings and extensions.
• Examples and packages setup with pnpm workspaces.
• Codesandbox setup for examples.

Instructions

• Add GH_TOKEN and NPM_TOKEN to secrets for CI workflows.
• Select Github Actions for Github pages publishing. Docs
• You may need to change workflow permissions to read/write to be able to publish pages with github actions. Go to Settings > Actions > General > Workflow permissions.
• You should enable https://socket.dev/ on the repo

Typescript

Override the tsconfig.json in the package with the following:

{
  "compilerOptions": {
    "noEmit": true, // for apps or anything that is not published to npm
    "emitDeclarationOnly": true, // for TS with JSDocs
    "module": "NodeNext", // for TS packages
    "moduleResolution": "NodeNext" // for TS packages
  }
}

Packages

• package1 - description
• package2 - description

Examples

• demo - description

Checkout examples

You can use Codesandbox and start hacking right away.

To clone it locally:

npx tiged hugomrdias/hd-template/examples/demo demo
cd demo
pnpm install
pnpm dev

You can try any of the examples by replacing demo with the name of the example you want to try.

Contributing

Read contributing guidelines here.

License

MIT © Hugo Dias