Skip to content

Commit 979eb8d

Browse files
authored
Merge pull request #18 from haroon10725/update-readme
update instructions for local development setup
2 parents 1a5dfe5 + fbaf80c commit 979eb8d

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -48,25 +48,41 @@ Under the hood, this library simply uses the official [@material/web](https://gi
4848

4949
3. Change to the project directory
5050

51-
4. To install all project dependencies, run the following command:
51+
4. To get started, ensure you have pnpm installed globally, run the following command:
52+
53+
```
54+
npm install -g pnpm
55+
```
56+
57+
5. To install all project dependencies, run the following command:
5258

5359
```
5460
pnpm i
5561
```
5662

57-
5. To build the project, run the following command (this needs to be done only once):
63+
6. To build the project, run the following commands (these needs to be done only once):
64+
65+
```
66+
cd packages/ui
67+
```
5868

5969
```
6070
pnpm build
6171
```
6272

63-
6. To run the code locally, run the following code:
73+
7. Return to the monorepo root:
74+
75+
```
76+
cd ../../
77+
```
78+
79+
8. To run the code locally, run the following code:
6480

6581
```
6682
pnpm dev
6783
```
6884

69-
This will run the demo app, and whenever you update the library, the app should rebuild
85+
This will run the demo app on http://localhost:3000, and whenever you update the library, the app should rebuild
7086

7187
### Roadmap 🚀
7288

0 commit comments

Comments
 (0)