diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 6733e56d..8f66a778 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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) diff --git a/docs/contributing-to-keyshade/running-things-locally/running-the-platform.md b/docs/contributing-to-keyshade/running-things-locally/running-the-platform.md new file mode 100644 index 00000000..58a74d77 --- /dev/null +++ b/docs/contributing-to-keyshade/running-things-locally/running-the-platform.md @@ -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 URL in a browser.