---
title: RELKIT documentation
description: Build your first TypeScript API, configure a module, solve a practical task, or look up an API.
pagination: false
mode: frame
sidebar:
  icon: compass
---

<div className="docs-home">

<DocsHero>

<p className="docs-hero-eyebrow">RELKIT documentation</p>

# Build your first TypeScript API.

<span id="why-relkit-exists"></span>

Build TypeScript backends with RELKIT. Start with a working HTTP endpoint, then add data, sign-in, and tests as you need them.

<span id="the-recommended-sequence"></span>

<div className="docs-hero-actions">
  <a href="/docs/learn/create-an-app">Start building</a>
  <a href="/docs/modules">Explore modules</a>
</div>

</DocsHero>

Create an application and send your first request. Continue with the same Orders application through persistence, authentication, testing, and production builds.

## Find what you need

<span id="choose-a-path"></span>
<span id="what-you-can-build"></span>

**[Learn](/docs/learn)**

Follow a continuous tutorial. New terms appear alongside the code that uses them.

**[Modules](/docs/modules)**

Understand a capability, configure its providers, and learn its limits.

**[Guides](/guides)**

Complete a specific task, such as uploading product images or caching prices.

**[Reference](/docs/api)**

Look up exact API signatures, types, options, and CLI commands.

You'll need basic TypeScript and Bun 1.3.10 or later for the first tutorial. Each later chapter names any additional requirements.

<div className="docs-home-details">

## Already have an application?

Choose a [module](/docs/modules) to configure, or a [guide](/guides) for the task you want to complete. For example, [Buckets](/docs/modules/storage) explains storage configuration, while [Upload product images](/guides/storage/upload-product-images) builds an HTTP upload endpoint.

The [Inspector](/docs/modules/operations/inspector) is an optional, separately installed tool. You can complete the tutorial and verify responses from your terminal.

For terminal workflows, start with the [CLI module](/docs/modules/cli). It connects project creation, scaffolding, development, and production builds to the [command reference](/docs/api/cli).

## Documentation and source [#documentation-and-source-of-truth]

Examples come from maintained repository sources. API reference comes from TypeScript, and CLI reference comes from the command's help model.

If a step doesn't work, [report the command and its diagnostic](https://github.com/rel-kit/relkit/issues), together with your package versions and a small reproduction.

</div>
</div>