Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (25 loc) · 915 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 915 Bytes

CONTRIBUTING

A big welcome and thank you for considering contributing to assistant-ui! It’s people like you that make it a reality for users in our community.

You can contribute by opening an issue, or by making a pull request. For large pull requests, we ask that you open an issue first to discuss the changes before submitting a pull request.

Setting up your environment

You need to have Node.js installed on your computer. We develop with the latest LTS version of Node.js.

Install the dependencies:

pnpm install

Make an initial build:

pnpm turbo build

(some packages rely on build outputs from other packages, even if you want to start the project in development mode)

Running the project

To run the docs project in development mode:

cd apps/docs
pnpm dev

To run the examples project in development mode:

cd examples/<your-example>
pnpm dev