-
-
Notifications
You must be signed in to change notification settings - Fork 115
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Added documentation for running the platform (#473)
- Loading branch information
1 parent
957ea8d
commit 8b8386b
Showing
2 changed files
with
40 additions
and
0 deletions.
There are no files selected for viewing
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
39 changes: 39 additions & 0 deletions
39
docs/contributing-to-keyshade/running-things-locally/running-the-platform.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,39 @@ | ||
--- | ||
description: Get to know how you can run the platform app! | ||
--- | ||
|
||
## Running the Platform | ||
|
||
The Platform App resides in the `apps/platform` directory. It is powered by NextJS and TypeScript. To run the Platform App locally, do the following: | ||
|
||
* In the project root, run: | ||
|
||
```sh | ||
pnpm i | ||
``` | ||
|
||
Next set up the platform app for development with: | ||
|
||
```sh | ||
pnpm dev:platform | ||
``` | ||
|
||
* Or cd into `apps/platform` and run: | ||
|
||
```sh | ||
pnpm dev | ||
``` | ||
|
||
## Testing your code | ||
|
||
We use Jest for testing. Run the tests when unit testing, or mock testing the platform app separately from the rest of the project. | ||
|
||
* To run tests in the root, use this command: | ||
|
||
```sh | ||
pnpm test:platform | ||
``` | ||
|
||
## Viewing the Platform App | ||
|
||
* You can view the platform app by opening the <http://localhost:3025> URL in a browser. |