UNPKG

npm-react-typescript-package-template

Version:

A template to generate a npm package for a react app using typescript and modern CI tools.

github.com/jlison/npm-react-typescript-package-template

jlison/npm-react-typescript-package-template

44 lines (34 loc) • 2.14 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# npm-react-typescript-package-template [![Build Status](https://travis-ci.org/jlison/npm-react-typescript-package-template.svg?branch=master)](https://travis-ci.org/jlison/npm-react-typescript-package-template) [![codecov](https://codecov.io/gh/jlison/npm-react-typescript-package-template/branch/master/graph/badge.svg)](https://codecov.io/gh/jlison/npm-react-typescript-package-template) [![Maintainability](https://api.codeclimate.com/v1/badges/c2478b21ac94e8e5fe16/maintainability)](https://codeclimate.com/github/jlison/npm-react-typescript-package-template/maintainability) [![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) A template to generate a npm package for a react app using typescript and modern CI tools. ## Usage 1. Fork. 2. Use fork to start a [new repository using the template.](https://help.github.com/en/articles/creating-a-repository-from-a-template) 3. Globally search and replace: - `npm-react-typescript-package-template` for `<your-repo-name>`. 4. Enable: - [Codecov.](https://codecov.io) - [Code Climate.](https://codeclimate.com/oss/) - [Travis CI.](https://travis-ci.org) - Add codecov env variable. - [semantic-release.](https://github.com/semantic-release/semantic-release/blob/HEAD/docs/usage/getting-started.md#getting-started) 5. Update this README.md, [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), [CONTRIBUTING.md](CONTRIBUTING.md), etc. ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END --> This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!