Skip to content

Commit

Permalink
docs: added running-the-web-app.md (#269)
Browse files Browse the repository at this point in the history
  • Loading branch information
qhtutorials authored and rajdip-b committed Jun 27, 2024
1 parent b7a81f6 commit 755ea12
Showing 1 changed file with 41 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
description: Get to know how you can run the web app!
---

## Running the Web App

The Web App resides in the `apps/web` directory. It is powered by NextJS and TypeScript. To run the Web App locally, do the following:

* In the project root, run:

```sh
pnpm i
```

Next set up the web app for development with:

```sh
pnpm dev:web
```

* Or cd into `apps/web` and run:

```sh
pnpm dev
```

## Testing your code

We use Jest for testing. Run the tests when unit testing, or mock testing the web app separately from the rest of the project.

* To run tests in the root, use this command:

```sh
pnpm test:web
```

## Viewing the Web App

* You can view the web app by opening the http://localhost:6969 URL in a browser.


0 comments on commit 755ea12

Please sign in to comment.