> For the complete documentation index, see [llms.txt](https://docs.keyshade.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keyshade.io/contributing-to-keyshade/running-things-locally/running-the-platform.md).

# Running the Platform

### 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.keyshade.io/contributing-to-keyshade/running-things-locally/running-the-platform.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.