> 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/design-of-our-code/organization-of-code.md).

# Organization of code

In this section, we will discuss how our codebase is organized. We have tried to keep the codebase as modular as possible to make it easier for developers to understand and contribute to the project. Here are the packages, sub-packages, and how they all contribute to the project.

## Packages under `apps` directory

The `apps` directory contains all the applications that are part of the project. Each application is a separate package and has its own `package.json` file. The applications are:

* [**api**](https://github.com/keyshade-xyz/keyshade/tree/develop/apps/api): The main API server that serves the REST API.
* [**web**](https://github.com/keyshade-xyz/keyshade/tree/develop/apps/web): The web application that serves the homepage.
* [**cli**](https://github.com/keyshade-xyz/keyshade/tree/develop/apps/cli): The CLI application that allows users to interact with the API and tap into live updates for their application.
* [**platform**](https://github.com/keyshade-xyz/keyshade/tree/develop/apps/platform): The platform application hosts the UI that allows users to do the actual work.

## Packages under `packages` directory

The `packages` directory contains all the shared packages that are used across the applications. These packages are:

* [**eslint-config-custom**](https://github.com/keyshade-xyz/keyshade/blob/main/packages/eslint-config-custom/README.md): Contains the custom ESLint configuration for the project.
* [**tsconfig**](https://github.com/keyshade-xyz/keyshade/blob/main/packages/tsconfig/README.md): Contains the custom TypeScript configuration for the project.

Apart from the `package.json` files used in the individual packages, we also have a root level `package.json` file that contains the scripts to run the applications and the shared packages. This file also contains the dependencies that are shared across the applications.


---

# 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/design-of-our-code/organization-of-code.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.