/react-npm-package-boilerplate

A simple boilerplate for React npm package with TypeScript.

Primary LanguageJavaScriptMIT LicenseMIT

react-npm-package-boilerplate

A simple boilerplate for npm package with TypeScript.

Dependencies

  • Node.js 16.13.0
  • React 18
  • TypeScript 4.5.4
  • Storybook
  • eslint
    • airbnb
    • airbnb-typescript
  • prettier
  • vitest
  • microbundle

Getting started

Installation

Clone this repository:

git clone git@github.com:RyoSogawa/react-npm-package-boilerplate.git

Open the directory and npm install:

cd react-npm-package-boilerplate
yarn

(Optional) Remove boilerplate data and commit:

rm -rf .git && git init && git add . && git commit -m "Initial commit"

Reference

https://github.com/hebertcisco/ts-npm-package-boilerplate

Template

MIT License code style: prettier

Installation

Install from npm:

# Using npm
npm install <PACKAGE_NAME>

# Using Yarn
yarn add <PACKAGE_NAME>

Usage

Configuration

Contribution

Please feel free to open an issue or make a pull request.

License

Distributed under the MIT License. See LICENSE for more information.