Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/1001josias/botmaster-ui

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/1001josias/botmaster-ui
Owner: 1001Josias
License: mit
Created: 2024-06-22T13:45:25.000Z (6 months ago)
Default Branch: master
Last Pushed: 2024-07-06T12:53:36.000Z (6 months ago)
Last Synced: 2024-10-14T15:01:10.219Z (2 months ago)
Language: TypeScript
Size: 4.8 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![CI](https://github.com/morewings/react-library-template/actions/workflows/merge-jobs.yml/badge.svg)](https://github.com/morewings/react-library-template/actions/workflows/merge-jobs.yml)

[![Storybook deploy](https://github.com/morewings/react-library-template/actions/workflows/pages.yml/badge.svg)](https://github.com/morewings/react-library-template/actions/workflows/pages.yml)

[![Use this template](https://img.shields.io/badge/use%20this-template-blue?logo=githu)](https://github.com/morewings/react-library-template/generate)

# React Library Template

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

With React Library Template Repository, you can focus on developing your React components and libraries without worrying about the configuration and setup.

Read [full documentation](https://dev.to/morewings/fastest-way-to-create-a-react-library-3mi7).

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

## Features

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

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

- [pnpm](https://pnpm.io/) for blazing fast package management.

- [Vite](https://vitejs.dev/) for speedy bundling

- [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.

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

- Optional [Tailwind CSS](https://tailwindcss.com/) support.

## Quickstart

### Prerequisites

1. Install **Node** >= 20.x.

2. Install **pnpm**. E.g. `corepack prepare pnpm@latest --activate`.

### Installation

Manually clone repo or use `degit`.

```shell script

# With CSS Modules config

npx degit github:morewings/react-library-template my-library

# With Tailwind CSS config

npx degit github:morewings/react-library-template#tailwind my-library

cd ./my-library

pnpm i

```

## Enable Tailwind CSS

You can find all changes at this [PR](https://github.com/morewings/react-library-template/pull/161) and [tailwind](https://github.com/morewings/react-library-template/tree/tailwind) branch.