Skip to content

Commit

Permalink
Merge pull request #18 from haroon10725/update-readme
Browse files Browse the repository at this point in the history
update instructions for local development setup
  • Loading branch information
haroon10725 authored Dec 17, 2024
2 parents 1a5dfe5 + fbaf80c commit 979eb8d
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,41 @@ Under the hood, this library simply uses the official [@material/web](https://gi

3. Change to the project directory

4. To install all project dependencies, run the following command:
4. To get started, ensure you have pnpm installed globally, run the following command:

```
npm install -g pnpm
```

5. 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):
6. To build the project, run the following commands (these needs to be done only once):

```
cd packages/ui
```

```
pnpm build
```

6. To run the code locally, run the following code:
7. Return to the monorepo root:

```
cd ../../
```

8. 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
This will run the demo app on http://localhost:3000, and whenever you update the library, the app should rebuild

### Roadmap 🚀

Expand Down

0 comments on commit 979eb8d

Please sign in to comment.