> For the complete documentation index, see [llms.txt](https://docs.pinot.apache.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pinot.apache.org/develop-and-contribute/codebase-basics.md).

# Codebase Basics

This section helps you get the Apache Pinot source code onto your machine, understand how the repository is organized, manage Maven dependencies correctly, and build Docker images from source.

## What you will learn

| Topic                                                                                                     | Description                                                                                                               |
| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| [Code Setup](/develop-and-contribute/codebase-basics/code-setup.md)                                       | Fork and clone the Pinot repository, install Maven, configure your IDE, and run a local QuickStart from source.           |
| [Code Modules and Organization](/develop-and-contribute/codebase-basics/code-modules-and-organization.md) | Understand every top-level Maven module -- SPI, core services, plugins, connectors, testing, and deployment artifacts.    |
| [Dependency Management](/develop-and-contribute/codebase-basics/dependency-management.md)                 | Follow the project's guidelines for adding, updating, and shading external dependencies in both core modules and plugins. |
| [Build Docker Images](/develop-and-contribute/codebase-basics/build-docker-images.md)                     | Build Pinot and Pinot-Superset Docker images from any branch or fork, including ARM64 builds.                             |

## Recommended reading order

1. **Code Setup** -- start here to get a working local build.
2. **Code Modules and Organization** -- learn where to find (and place) code.
3. **Dependency Management** -- review the rules before adding any new library.
4. **Build Docker Images** -- package your changes into container images for testing or deployment.

## Prerequisites

* Git installed and configured with SSH keys for GitHub.
* JDK 25.
* Apache Maven 3.6 or later.
* Docker (required only for building container images).

## Next step

Once you are comfortable navigating the codebase, learn how to extend Pinot with custom plugins:

* [Extending Pinot](/develop-and-contribute/extending-pinot.md)


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pinot.apache.org/develop-and-contribute/codebase-basics.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.