To contribute to Open UI, follow these steps:
-
Fork the repository by clicking on the "Fork" button at the top right corner of the GitHub page.
-
Clone your forked repository to your local machine:
git clone https://github.com/OpenLabs-dev/ui.git
-
Create a new branch for your changes:
git switch -c feat/my-feature
-
Make the necessary changes and improvements to the codebase.
-
Commit your changes with a descriptive commit message:
git commit -m "feat: new feature"
-
Push your changes to your forked repository:
git push origin feat/my-feature
-
Open a pull request (PR) on the original repository's GitHub page.
-
Provide a clear and detailed description of your changes in the PR.
-
Wait for the maintainers to review your changes and address any feedback or comments.
-
Once your changes are approved, they will be merged into the main branch.
Thank you for your contribution to Open UI! We appreciate your support and look forward to your ideas and improvements.
To start developing with Open UI, follow these steps:
- Activate corepack
corepack enable pnpm
-
Install the necessary dependencies by running the following command in your terminal:
pnpm install --frozen-lockfile
-
Start the development to built components:
pnpm compile
Happy coding!
-
Start playground
pnpm dev:playground
-
Start the development to docs:
pnpm dev
Happy coding!
-
Start playground
pnpm build-web