From 485fd8a8ac6e0d00fad582652ccc3f851db76f9f Mon Sep 17 00:00:00 2001 From: Muhammad Haroon Date: Sun, 15 Dec 2024 21:13:37 +0500 Subject: [PATCH] add instructions for local development setup --- packages/ui/README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/packages/ui/README.md b/packages/ui/README.md index 46bf6f7..9e5ea43 100644 --- a/packages/ui/README.md +++ b/packages/ui/README.md @@ -40,7 +40,33 @@ Under the hood, this library simply uses the official [@material/web](https://gi ## Contributing -We're looking for maintainers and contributors! +### Local Development Setup 💻 + +1. Fork this repository + +2. Clone your forked copy of the project + +3. Change to the project directory + +4. To install all project dependencies, run the following command: + +``` +pnpm i +``` + +5. To build the project, run the following command (this needs to be done only once): + +``` +pnpm build +``` + +6. To run the code locally, run the following code: + +``` +pnpm dev +``` + +This will run the demo app, and whenever you update the library, the app should rebuild ### Roadmap 🚀