https://github.com/hugomrdias/hd-template
https://github.com/hugomrdias/hd-template
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hugomrdias/hd-template
- Owner: hugomrdias
- License: mit
- Created: 2023-03-08T19:07:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T10:15:48.000Z (2 months ago)
- Last Synced: 2025-04-28T13:09:02.393Z (about 2 months ago)
- Language: JavaScript
- Size: 490 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/CONTRIBUTING.md
- License: license
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 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](https://github.com/googleapis/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](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow)
- 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 on the repo
#### Typescript
Override the `tsconfig.json` in the package with the following:
```json
{
"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](https://github.com/hugomrdias/hd-template/tree/master/packages/package1) - description
- [package2](https://github.com/hugomrdias/hd-template/tree/master/packages/package2) - description
## Examples
- [`demo`](https://github.com/hugomrdias/hd-template/tree/master/examples/demo) - description [](https://stackblitz.com/github/hugomrdias/hd-template/tree/master/examples/demo?title=HD%20Template%20Demo&file=src/main.jsx&hideExplorer=1&theme=dark)
To clone it locally:
```bash
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](.github/CONTRIBUTING.md).
[](https://codespaces.new/hd-template/examples)
## License
[MIT](./license) © [Hugo Dias](http://hugodias.me)