RELKIT documentation
Build your first TypeScript API.
Build TypeScript backends with RELKIT. Start with a working HTTP endpoint, then add data, sign-in, and tests as you need them.
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
Learn
Follow a continuous tutorial. New terms appear alongside the code that uses them.
Modules
Understand a capability, configure its providers, and learn its limits.
Guides
Complete a specific task, such as uploading product images or caching prices.
Reference
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.
Already have an application?
Choose a module to configure, or a guide for the task you want to complete. For example, Buckets explains storage configuration, while Upload product images builds an HTTP upload endpoint.
The 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. It connects project creation, scaffolding, development, and production builds to the command reference.
Documentation and source
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, together with your package versions and a small reproduction.