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

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

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/vtex/typescript-library-boilerplate
• Owner: vtex
• License: mit
• Created: 2021-03-16T20:45:41.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-17T18:58:42.000Z (over 5 years ago)
• Last Synced: 2026-04-21T11:57:27.688Z (2 months ago)
• Language: JavaScript
• Size: 130 KB
• Stars: 1
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          





# 🚀 Just run `node setup` to start a new project











# [libraryNameWithSpacesAndUpperCases]

[![Build Status](https://travis-ci.org/[repositoryOwner]/[repositoryName].svg?branch=master)](https://travis-ci.org/[repositoryOwner]/[repositoryName])

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

[![Library minified size](https://badgen.net/bundlephobia/min/[libraryName])](https://bundlephobia.com/result?p=[libraryName])

[![Library minified + gzipped size](https://badgen.net/bundlephobia/minzip/[libraryName])](https://bundlephobia.com/result?p=[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).