Skip to content

Commit

Permalink
docs: Added documentation for running the platform (#473)
Browse files Browse the repository at this point in the history
  • Loading branch information
Allan2000-Git authored Oct 3, 2024
1 parent 957ea8d commit 8b8386b
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
- [Running things locally](contributing-to-keyshade/running-things-locally/README.md)
- [Running the API](contributing-to-keyshade/running-things-locally/running-the-api.md)
- [Running the Web](contributing-to-keyshade/running-things-locally/running-the-web-app.md)
- [Running the Platform](contributing-to-keyshade/running-things-locally/running-the-platform.md)
- [Running the CLI](contributing-to-keyshade/running-things-locally/running-the-cli.md)
- [API Testing](contributing-to-keyshade/running-things-locally/api-testing.md)
- [Docker Support](contributing-to-keyshade/running-things-locally/docker-support.md)
Expand Down
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.

0 comments on commit 8b8386b

Please sign in to comment.