https://github.com/morewings/cra-template-npm-library

Create React App template to build and publish NPM libraries with typescript support, and rollup, eslint, stylelint configurations
https://github.com/morewings/cra-template-npm-library

cra-template create-react-app create-react-app-template eslint npm-library react-testing-library stylelint template typescript

Last synced: about 2 months ago
JSON representation

Create React App template to build and publish NPM libraries with typescript support, and rollup, eslint, stylelint configurations

• Host: GitHub
• URL: https://github.com/morewings/cra-template-npm-library
• Owner: morewings
• License: mit
• Archived: true
• Created: 2020-03-28T18:55:58.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-07T19:38:20.000Z (10 months ago)
• Last Synced: 2024-08-17T08:05:03.558Z (6 months ago)
• Topics: cra-template, create-react-app, create-react-app-template, eslint, npm-library, react-testing-library, stylelint, template, typescript
• Language: JavaScript
• Homepage: https://github.com/morewings/cra-template-npm-library/wiki
• Size: 4.78 MB
• Stars: 24
• Watchers: 2
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Deprecation notice

**Create React App is not updated by its maintainers anymore. So this project can't be updated as well. I recommend to use [React Library Template](https://github.com/morewings/react-library-template) which has all the same functionality plus new features.**

# NPM library Create React App template

[![NPM library Create React App template logo](./design/logo.png)](#)

[Create React App](https://github.com/facebook/create-react-app) (CRA) template to build and publish NPM libraries with **rollup**, **eslint** and **stylelint** configurations.

🎁👌🤓 **NEW!** Now with **Typescript** support.

Read [full documentation](https://github.com/morewings/cra-template-npm-library/wiki).

Visit [Demo Storybook](https://morewings.github.io/cra-template-npm-library).

## Features

- Supports **Typescript** and **Javascript**.

- Bundles `commonjs` and `es` module formats.

- [Husky](https://github.com/typicode/husky) for git hooks.

- [Eslint](https://eslint.org/) and [stylelint](https://stylelint.io/).

- [Rollup](https://rollupjs.org/guide/en/) for bundling.

- [Jest](https://jestjs.io/) and [react-testing-library](https://testing-library.com/docs/react-testing-library/intro) for testing.

- Supports CSS modules, SASS/SCSS and PostCSS.

- [Storybook](https://storybook.js.org/) for documentation and demo.

- And [much more](https://github.com/morewings/cra-template-npm-library/wiki).

## Quickstart

```shell script

npx create-react-app %PROJECT_NAME% --template npm-library

yarn create react-app %PROJECT_NAME% --template npm-library

pnpm create react-app %PROJECT_NAME% --template npm-library

```

Then

```shell script

cd %PROJECT_NAME%

npm run prepare

yarn run prepare

pnpm run prepare

```