Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: about 3 hours 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.

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).