README.md

End-to-end typesafe APIs made easy

The client above is not importing any code from the server, only it's type declarations.
_{^{Import type only imports declarations to be used for type annotations and declarations. It always gets fully erased, so there’s no remnant of it at runtime.}}

Intro

tRPC is a framework for building strongly typed RPC APIs with TypeScript. Alternatively, you can think of it as a way to avoid APIs altogether.

• 🧙‍♂️  Automatic typesafety & autocompletion inferred from your API-paths, their input data, outputs, & 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-library + Next.js/Express adapters. (But tRPC is not tied to React - reach out if you want to make a Svelte/Vue/... lib)
• 🥃  Simple to use APIs for queries & mutations + experimental subscriptions support.
• 👀  Quite a few examples in the ./examples-folder
• ✅  Well-tested & running in production.

tRPC requires TypeScript > 4.1 because of Template Literal Types, but you can get some benefits with autocompletion etc even if you use raw JS.

---

• Intro
• Usage
• Example apps
• Contributing / Development workflow
  • Hacking around with it
  • Testing
• Contributors ✨

Usage

👉 See documentation on trpc.io. 👈

Quick start:

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

Example apps

Description	URL	Links
Next.js starter with Prisma, E2E testing, & ESLint Quick start with create-next-app npx create-next-app --example https://github.com/trpc/trpc --example-path examples/next-prisma-starter trpc-prisma-starter	n/a	CodeSandbox Source
Next.js TodoMVC-example with SSG & Prisma. Quick start with create-next-app npx create-next-app --example https://github.com/trpc/trpc --example-path examples/next-prisma-todomvc trpc-todo	todomvc.trpc.io	CodeSandbox Source
Vanilla standalone server & procedure calls with node.js	n/a	CodeSandbox Source
Express server & procedure calls with node.js. Uses experimental subscriptions.	n/a	CodeSandbox Source

Contributing / Development workflow

git clone [email protected]:trpc/trpc.git
cd trpc
yarn

Hacking around with it

In one terminal, will run preconstruct watch in parallel which builds all packages/* on change:

yarn dev

In another terminal, you can for instance navigate to examples/next-prisma-starter and run yarn dev & it will update whenever code is changed in the packages.

Testing

yarn test --watch

Testing is currently coalesced in ./packages/server/test - we import the different libs from here, this makes it easier for us to do integration testing + getting test coverage on the whole codebase.

Some things regarding subscriptions is excluded in the coverage as it's an experimental feature

Contributors ✨

Original 0.x-version was created by colinhacks and >1.x was created by KATT.

Alex Johansson 🤔 💻 ⚠️ 📖 💡 🚧	Colin McDonnell 🤔 💻 ⚠️ 📖	Pieter Venter 🤔 👀	Kalle 🐛	Malte Granderath 🐛	Kristóf Poduszló 🤔 🐛	Rich Haines 💡
Simon Edelmann 💻 🤔 ⚠️ 📖	Anthony Short 💵	Hampus Kraft 💵

---