EnsembleUI / ensemble-react

Ensemble React

This is a monorepo containing the React elements for Ensemble, built with Turborepo.

To get started integrating Ensemble to your React App, see the starter app and README.

Getting Started

Clone the repo and then cd into the root directory of the repo.

Activate pnpm with node's corepack:

corepack prepare pnpm@6.32.2 --activate

pnpm docs

Run the following commands in the root directory:

pnpm install
pnpm build

What's inside?

This repo includes the following packages/apps:

Apps and Packages

• starter: a React app boostrapped with Create React App, that uses the Ensemble runtime
• framework: a low level Typescript and React hooks library that contains the plumbing for Ensemble
• runtime: a React library for running an Ensemble App
• eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• tsconfig: tsconfig.jsons used throughout the monorepo

Each package/app is 100% TypeScript.

How to run the complete project

You can run the app in dev mode using this command

pnpm dev

This command will start the development server, and it should automatically open your default web browser displaying the app. If it doesn't, you can manually navigate to http://localhost:3000 in your browser.

Utilities

This Turborepo has some additional tools already setup for you:

• TypeScript for static type checking
• ESLint for code linting
• Prettier for code formatting

Useful Links

Learn more about the power of Turborepo:

• Tasks
• Caching
• Remote Caching
• Filtering
• Configuration Options
• CLI Usage