Fork

Forking

Click `Fork` in WindUI Repository

Forking repository to own account Fork Preview Fork-2 Preview

Clone forked repository to local machine

Clone it in terminal

git clone https://github.com/[YOUR_GITHUB_USERNAME]/WindUI.git
cd WindUI

This command will create a copy of the WindUI project in your working directory, allowing you to modify and customize it as needed.

Install required dependencies

You need cargo to install darklua

cargo install darklua

Build WindUI

After your changes in the local repository in ./WindUI, you can build the changes and test them

npm run build

this will update the ./WindUI/dist/main.lua file (build file)

Thank you for your interest in WindUI! If you want to help, create a pull request with improvements, fixes, or new components. Describe your changes in the comments, make sure the code follows the project style, and that tests pass.

Welcome contributions:

new components and utilities
documentation improvements
bug fixes

Before submitting a PR, ensure your code builds successfully and there are no conflicts with the main branch.