Skip to content

Latest commit

Β 

History

History
240 lines (195 loc) Β· 15.4 KB

README.md

File metadata and controls

240 lines (195 loc) Β· 15.4 KB
tRPC

tRPC

Move fast and break nothing.
End-to-end typesafe APIs made easy.

codecov weekly downloads MIT License Discord
Twitter

Demo

The client above is not importing any code from the server, only its type declarations.


Note

You are looking at the next-branch of tRPC which is the current work in progress representing version 11.

  • The functionality is stable and can be used in production, but we may do small breaking API-changes between patches until we reach 11.0.0
  • The packages are published with the next-tag on npm
  • For the list of changes made, see https://trpc.io/docs/v11/migrate-from-v10-to-v11

Intro

tRPC allows you to easily build & consume fully typesafe APIs without schemas or code generation.

Features

  • βœ…Β  Well-tested and production ready.
  • πŸ§™β€β™‚οΈΒ  Full static typesafety & autocompletion on the client, for inputs, outputs, and errors.
  • 🐎  Snappy DX - No code generation, run-time bloat, or build pipeline.
  • πŸƒΒ  Light - tRPC has zero deps and a tiny client-side footprint.
  • 🐻  Easy to add to your existing brownfield project.
  • πŸ”‹Β  Batteries included - React.js/Next.js/Express.js/Fastify adapters. (But tRPC is not tied to React, and there are many community adapters for other libraries)
  • πŸ₯ƒΒ  Subscriptions support.
  • ⚑️  Request batching - requests made at the same time can be automatically combined into one
  • πŸ‘€Β  Quite a few examples in the ./examples-folder

Quickstart

There are a few examples that you can use for playing out with tRPC or bootstrapping your new project. For example, if you want a Next.js app, you can use the full-stack Next.js example:

Quick start with a full-stack Next.js example:

# yarn
yarn create next-app --example https://github.com/trpc/trpc --example-path examples/next-prisma-starter trpc-prisma-starter

# npm
npx create-next-app --example https://github.com/trpc/trpc --example-path examples/next-prisma-starter trpc-prisma-starter

# pnpm
pnpm create next-app --example https://github.com/trpc/trpc --example-path examples/next-prisma-starter trpc-prisma-starter

# bun
bunx create-next-app --example https://github.com/trpc/trpc --example-path examples/next-prisma-starter trpc-prisma-starter

πŸ‘‰ See full documentation on tRPC.io. πŸ‘ˆ

Star History

Star History Chart

Core Team

Do you want to contribute? First, read the Contributing Guidelines before opening an issue or PR so you understand the branching strategy and local development environment. If you need any more guidance or want to ask more questions, feel free to write to us on Discord!


Alex / KATT
πŸ‘‹ Hi, I'm Alex and I am the creator of tRPC, don't hesitate to contact me on Twitter or email if you are curious about tRPC in any way.

Project leads

The people who lead the API-design decisions and have the most active role in the development


Julius Marminge

Alex / KATT

Active contributors

People who actively help out improving the codebase by making PRs and reviewing code


Nick Lucas

Flo

Sachin Raja

Special shout-outs


Chris Bautista

Theo Browne
Ahmed%20Elsakaan
Ahmed Elsakaan

James Berry

Kamil OgΓ³rek

Sponsors

If you enjoy working with tRPC and want to support us, consider giving a token appreciation by GitHub Sponsors!

πŸ₯‡ Gold Sponsors

Tola
Tola

πŸ₯ˆ Silver Sponsors

Cal.com,%20Inc.
Cal.com, Inc.

πŸ₯‰ Bronze Sponsors

Echobind
Echobind
Dr.%20B
Dr. B
Flylance
Flylance

😻 Smaller Backers

Ahoy%20Labs
Ahoy Labs
Dyaa
Dyaa
Brooke
Brooke
Max%20Greenwald
Max Greenwald
Tom%20Ballinger
Tom Ballinger
Faraz%20Patankar
Faraz Patankar
Adam%20Slaker
Adam Slaker
Dmitry%20Maykov
Dmitry Maykov
Chris%20Bradley
Chris Bradley
Ahmed%20Elsakaan
Ahmed Elsakaan
Hampus%20Kraft
Hampus Kraft
Illarion%20Koperski
Illarion Koperski
SchlagerKhan
SchlagerKhan
Jared%20Wyce
Jared Wyce
fanvue
fanvue
Andrew%20Brown
Andrew Brown
Ascent%20Factory
Ascent Factory
Unkey
Unkey
Jonas%20Strassel
Jonas Strassel
Jordy
Jordy
Daniel%20Burger
Daniel Burger
Scale%20Leap
Scale Leap
Drew%20Powers
Drew Powers
Drizzle%20Team
Drizzle Team
Liran%20Goldman
Liran Goldman
Spencer%20McKenney
Spencer McKenney
Proxidize
Proxidize
Oskar%20Hertzman
Oskar Hertzman
Imamuzzaki%20Abu%20Salam
Imamuzzaki Abu Salam

All contributors ✨

A table of avatars from the project's contributors


Powered by Vercel