https://github.com/vitorluizc/typescript-library-boilerplate

Initialize it running "node ./setup.js". A TypeScript library boilerplate. Check types pretty strictly; generates CommonJS, ESM and UMD bundles with Rollup.js; setup unit tests with Jest; and generate docs from sources with Typedoc.
https://github.com/vitorluizc/typescript-library-boilerplate

boilerplate library library-boilerplate typescript typescript-boilerplate typescript-library typescript-library-boilerplate

Last synced: 3 months ago
JSON representation

Initialize it running "node ./setup.js". A TypeScript library boilerplate. Check types pretty strictly; generates CommonJS, ESM and UMD bundles with Rollup.js; setup unit tests with Jest; and generate docs from sources with Typedoc.

• Host: GitHub
• URL: https://github.com/vitorluizc/typescript-library-boilerplate
• Owner: VitorLuizC
• License: mit
• Created: 2019-02-18T15:32:45.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-20T01:48:37.000Z (9 months ago)
• Last Synced: 2025-03-23T00:49:47.620Z (3 months ago)
• Topics: boilerplate, library, library-boilerplate, typescript, typescript-boilerplate, typescript-library, typescript-library-boilerplate
• Language: JavaScript
• Homepage:
• Size: 1.33 MB
• Stars: 98
• Watchers: 6
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [libraryNameWithSpacesAndUpperCases]

[![Continuous Integrations](https://github.com/[repositoryOwner]/[repositoryName]/actions/workflows/continuous-integrations.yaml/badge.svg?branch=main)](https://github.com/[repositoryOwner]/[repositoryName]/actions/workflows/continuous-integrations.yaml)

[![License](https://badgen.net/github/license/[repositoryOwner]/[repositoryName])](./LICENSE)

[![Package tree-shaking](https://badgen.net/bundlephobia/tree-shaking/[libraryName])](https://bundlephobia.com/package/[libraryName])

[![Package minified & gzipped size](https://badgen.net/bundlephobia/minzip/[libraryName])](https://bundlephobia.com/package/[libraryName])

[![Package dependency count](https://badgen.net/bundlephobia/dependency-count/react[libraryName])](https://bundlephobia.com/package/[libraryName])

## Installation

This library is published in the NPM registry and can be installed using any compatible package manager.

```sh

npm install [libraryName] --save

# For Yarn, use the command below.

yarn add [libraryName]

```

### Installation from CDN

This module has an UMD bundle available through JSDelivr and Unpkg CDNs.

```html

  // UMD module is exposed through the "[libraryCamelCaseName]" global variable.

  console.log([libraryCamelCaseName]);

```

## Documentation

[Documentation generated from source files by Typedoc](./docs/README.md).

## License

Released under [MIT License](./LICENSE).