Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ensembleui/ensemble-react
https://github.com/ensembleui/ensemble-react
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ensembleui/ensemble-react
- Owner: EnsembleUI
- License: bsd-3-clause
- Created: 2023-08-24T23:25:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-28T06:42:50.000Z (about 1 month ago)
- Last Synced: 2024-11-28T07:29:37.474Z (about 1 month ago)
- Language: TypeScript
- Size: 3.18 MB
- Stars: 15
- Watchers: 6
- Forks: 1
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/EnsembleUI/ensemble-react/blob/main/apps/starter).
## Getting Started
Clone the repo and then cd into the root directory of the repo.
Activate `pnpm` with node's corepack:
```sh
corepack prepare [email protected] --activate
```
[pnpm docs](https://pnpm.io/installation#using-corepack)
Run the following commands in the root directory:
```sh
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.json`s used throughout the monorepo
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
### How to run the complete project
You can run the app in dev mode using this command
```sh
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](https://www.typescriptlang.org/) for static type checking
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io) for code formatting
## Useful Links
Learn more about the power of Turborepo:
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)