https://github.com/patrickroberts/template
Rollup template for TypeScript projects
https://github.com/patrickroberts/template
airbnb babel commonjs es-module eslint github-workflows javascript jest rollup-template typedoc typescript umd
Last synced: 9 months ago
JSON representation
Rollup template for TypeScript projects
- Host: GitHub
- URL: https://github.com/patrickroberts/template
- Owner: patrickroberts
- License: mit
- Created: 2020-08-16T16:59:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-18T01:21:29.000Z (over 3 years ago)
- Last Synced: 2025-01-21T13:07:05.520Z (11 months ago)
- Topics: airbnb, babel, commonjs, es-module, eslint, github-workflows, javascript, jest, rollup-template, typedoc, typescript, umd
- Language: TypeScript
- Homepage: https://patrickroberts.github.io/template
- Size: 392 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# template
[](https://github.com/patrickroberts/template/actions)
[](https://codecov.io/gh/patrickroberts/template)
[](https://github.com/patrickroberts/template/blob/master/LICENSE)
## Rollup template for TypeScript projects
### Features
- [TypeScript]
- [Babel]
- [Rollup] bundles
- CommonJS
- ES Module
- UMD
- Types
- [ESLint]
- [Airbnb Style]
- [Jest]
- Allows TypeScript in test files
- [TypeDoc]
- [GitHub Workflows] for
- Building
- Code Coverage
- Documentation
- Publishing
### Installation
```sh
npx degit patrickroberts/template my-new-project
cd my-new-project
npm install
```
### Getting Started
To begin live development with incremental building and testing
```sh
npm run watch
```
### Continuous Integration
Every push to the `master` branch will trigger an automated build and deploy generated documentation to GitHub Pages from the root of the `gh-pages` branch.
Every release will publish the package pre-bundled to [npm]. You need to configure your credentials by [creating a secret] with the name [`NPM_TOKEN`].
[TypeScript]: https://www.typescriptlang.org/
[Babel]: https://babeljs.io/
[Rollup]: https://rollupjs.org/
[ESLint]: https://eslint.org/
[Airbnb Style]: https://github.com/airbnb/javascript
[Jest]: https://jestjs.io/
[TypeDoc]: https://typedoc.org/
[GitHub Workflows]: https://docs.github.com/actions
[npm]: https://www.npmjs.com/
[creating a secret]: https://docs.github.com/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository
[`NPM_TOKEN`]: https://docs.npmjs.com/using-private-packages-in-a-ci-cd-workflow