-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e227e52
commit c2bd44a
Showing
2 changed files
with
73 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,73 @@ | ||
# js-template | ||
# 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 ESLint, prettier, 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 <https://socket.dev/> 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 | ||
|
||
### Checkout examples | ||
|
||
You can use [Codesandbox](https://githubbox.com/hugomrdias/hd-template/tree/master/examples/demo) and start hacking right away. | ||
|
||
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). | ||
|
||
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/hd-template/examples) | ||
|
||
## License | ||
|
||
[MIT](./license) © [Hugo Dias](http://hugodias.me) |
This file was deleted.
Oops, something went wrong.