https://github.com/fission-codes/js-template
⌘ Fission JS Template
https://github.com/fission-codes/js-template
Last synced: about 1 year ago
JSON representation
⌘ Fission JS Template
- Host: GitHub
- URL: https://github.com/fission-codes/js-template
- Owner: fission-codes
- License: apache-2.0
- Created: 2023-10-27T09:48:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T07:18:36.000Z (over 2 years ago)
- Last Synced: 2025-03-25T11:48:18.400Z (about 1 year ago)
- Language: JavaScript
- Size: 504 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE-APACHE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Fission JS Template
[](https://fission.codes)
[](https://discord.gg/zAQBDEq)
[![Discourse users]()](https://talk.fission.codes)
## Usage (remove this section)
This section describes how to use this template. Remove this section from your README after you have read it.
### 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 on the repo
- Check the markdown files inside `.github` folder and update them with your information. Codeowners and issue templates assignees should be updated with your team members.
#### 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/fission-codes/js-template/tree/master/packages/package1) - description
- [package2](https://github.com/fission-codes/js-template/tree/master/packages/package2) - description
## Examples
- [`demo`](https://github.com/fission-codes/js-template/tree/master/examples/demo) - description
### Checkout examples
You can use Codesandbox and start hacking right away.
To clone it locally:
```bash
npx tiged fission-codes/js-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
This project is licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](./LICENSE-APACHE) or
[http://www.apache.org/licenses/LICENSE-2.0][apache])
- MIT license ([LICENSE-MIT](./LICENSE-MIT) or
[http://opensource.org/licenses/MIT][mit])
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.
[apache]: https://www.apache.org/licenses/LICENSE-2.0
[mit]: http://opensource.org/licenses/MIT