Skip to content

Commit 485fd8a

Browse files
committed
add instructions for local development setup
1 parent 750fcf0 commit 485fd8a

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

Diff for: packages/ui/README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,33 @@ Under the hood, this library simply uses the official [@material/web](https://gi
4040

4141
## Contributing
4242

43-
We're looking for maintainers and contributors!
43+
### Local Development Setup 💻
44+
45+
1. Fork this repository
46+
47+
2. Clone your forked copy of the project
48+
49+
3. Change to the project directory
50+
51+
4. To install all project dependencies, run the following command:
52+
53+
```
54+
pnpm i
55+
```
56+
57+
5. To build the project, run the following command (this needs to be done only once):
58+
59+
```
60+
pnpm build
61+
```
62+
63+
6. To run the code locally, run the following code:
64+
65+
```
66+
pnpm dev
67+
```
68+
69+
This will run the demo app, and whenever you update the library, the app should rebuild
4470

4571
### Roadmap 🚀
4672

0 commit comments

Comments
 (0)