Enterwell UI

Collection of UI packages used for Enterwell projects.

What's inside?

This repository includes the following:

Packages

• @enterwell/react-ui - React component library
• @enterwell/react-hooks - React hooks library
• @enterwell/react-mui-hooks - React MUI hooks library

Other (not published)

• docs - Documentation app (built with nextra) available at enterwell.github.io/ui
• eslint-config-custom - eslint configurations (includes eslint-config-next)
• tsconfig - tsconfig.jsons used throughout the monorepo

Development

Requirements

• nvm for Windows
  • Run nvm install lst && nvm use lts
  • Optionally install Node 18 (LTS) manually from Node.js Download page
• pnpm
• Visual Studio Code (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:

pnpm i
pnpm build

Develop

Note: Run pnpm build before pnpm dev to ensure that all packages have required files built and ready.

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

pnpm i
pnpm dev

Code generator

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

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