https://github.com/enterwell/ui

Enterwell UI library
https://github.com/enterwell/ui

hooks-library mui nextjs react ui-components

Last synced: about 2 months ago
JSON representation

Enterwell UI library

• Host: GitHub
• URL: https://github.com/enterwell/ui
• Owner: Enterwell
• License: mit
• Created: 2023-09-07T16:32:24.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-21T19:52:00.000Z (3 months ago)
• Last Synced: 2024-10-22T02:39:50.739Z (3 months ago)
• Topics: hooks-library, mui, nextjs, react, ui-components
• Language: TypeScript
• Homepage: https://enterwell.github.io/ui/
• Size: 1.3 MB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

      

      

    

  

  
Enterwell UI




    Collection of UI packages used for Enterwell projects.



## What's inside?

This repository includes the following:

### Packages

- `@enterwell/react-ui` [![npm version](https://badge.fury.io/js/@enterwell%2Freact-ui.svg)](https://badge.fury.io/js/@enterwell%2Freact-ui) - React component library

- `@enterwell/react-hooks` [![npm version](https://badge.fury.io/js/@enterwell%2Freact-hooks.svg)](https://badge.fury.io/js/@enterwell%2Freact-hooks) - React hooks library

- `@enterwell/react-mui-hooks` [![npm version](https://badge.fury.io/js/@enterwell%2Freact-mui-hooks.svg)](https://badge.fury.io/js/@enterwell%2Freact-mui-hooks) - React MUI hooks library

#### Other (not published)

- `docs` - Documentation app (built with [nextra](https://nextra.site/)) available at [enterwell.github.io/ui](https://enterwell.github.io/ui/)

- `eslint-config-custom` - `eslint` configurations (includes `eslint-config-next`)

- `tsconfig` - `tsconfig.json`s used throughout the monorepo

## Development

### Requirements

- [nvm for Windows](https://github.com/coreybutler/nvm-windows)

  - Run `nvm install lst && nvm use lts`

  - Optionally install Node 18 (LTS) manually from [Node.js Download page](https://nodejs.org/en/download)

- [pnpm](https://pnpm.io/installation)

- [Visual Studio Code](https://code.visualstudio.com/) (optional)

Open workspace file `ui.code-workspace` with VS Code or your favorite editor.

### Build

To build all apps and packages, run the following command:

```bash

pnpm i

pnpm build

```

### Develop

To develop all apps and packages, run the following command:

```bash

pnpm i

pnpm dev

```

#### Code generator

Run following command (from root) and select appropriate generator and modify generated files.

```bash

pnpm turbo gen

```

Available generators:

| Generator | Description | Command |

|-----------|-------------|---------|

| component | Creates react component in `react-ui` package along with basic documentation. | `pnpm turbo gen component` |

| react-hook | Creates react hook in `react-hooks` package alogn with basic documentation. | `pnpm turbo gen react-hook` |

| react-mui-hook | Creates react hook in `react-mui-hooks` package alogn with basic documentation. | `pnpm turbo gen react-mui-hook` |