-
-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added running-the-web-app.md (#269)
- Loading branch information
1 parent
b7a81f6
commit 755ea12
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
41 changes: 41 additions & 0 deletions
41
docs/contributing-to-keyshade/running-things-locally/running-the-web-app.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|