https://github.com/yet3/react-typescript-rollup-npm-template

https://github.com/yet3/react-typescript-rollup-npm-template

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/yet3/react-typescript-rollup-npm-template
• Owner: yet3
• License: mit
• Created: 2022-07-30T20:35:49.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-08-12T00:56:51.000Z (almost 4 years ago)
• Last Synced: 2025-02-07T01:24:32.532Z (over 1 year ago)
• Language: TypeScript
• Size: 86.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# react-typescript-rollup-npm-template

![GitHub license](https://img.shields.io/github/license/yet3/react-typescript-rollup-npm-template?style=flat)

A base to start development of react npm package.

### Includes

- Rollup

  - Outputs: esm, cjs

  - Scss

  - Typescript

  - Terser

  - Dts

- Husky

- Prettier

- Jest

  - React Testing Library

  - jest-environment-jsdom

- Example project

  - React

  - Typescript/Javascript

  - Vite

  - TailwindCSS

### Installation

```sh

git clone https://github.com/yet3/react-typescript-rollup-npm-template.git

cd react-typescript-rollup-npm-template && yarn

```

### Commands

- build - build package

- dev - watch and build package while concurrently running example project (remember to run ```yarn``` once in 'example' directory before this command)

- format - format entire project (including 'example')

- test - run all tests

### Directory structure

```tree

├── .husky          Husky's configuration

├── dist            Output directory

├── example         Example react project

├── src             Source code

└── __tests__       Tests

```