Learn & Contribute

Discover how to learn and contribute to the oRPC project, including advanced guides and contributor resources.

Welcome to the Learn & Contribute section! Here you can explore advanced guides and resources to deepen your understanding of oRPC and contribute to its development.

Architecture Overview

Each part of oRPC serves a specific purpose in the overall system. The source files linked below provide detailed implementation insights for contributors.

Procedure Builder/Caller

The core developer experience of oRPC. This lightweight component consists of just a few files that enable you to define and call procedures within the same environment.

• server/src/builder.ts
• server/src/procedure-decorated.ts
• server/src/procedure-client.ts

Contract First

Extends the Procedure Builder/Caller by separating contract definition from implementation, enabling contract-first development.

• contract/src/builder.ts
• server/src/implementer.ts

Standard Server

Abstracts runtime environments, allowing oRPC adapters to run seamlessly across Cloudflare Workers, Node.js, Bun, Deno, and other platforms without runtime-specific concerns.

• standard-server
• standard-server-fetch
• standard-server-node
• standard-server-fastify
• standard-server-aws-lambda
• standard-server-peer

RPC Handler/Link

Implements the RPC Protocol for efficient and lightweight remote procedure invocation. Supports native types like Date, Map, Set, BigInt, and more.

• client/src/adapters/standard/rpc-link.ts
• server/src/adapters/standard/rpc-handler.ts

OpenAPI Handler/Link/Generator

Implements OpenAPI support for standards-compliant remote procedure invocation following the OpenAPI Specification.

• openapi-client/src/adapters/standard/openapi-link.ts
• openapi/src/adapters/standard/openapi-handler.ts
• openapi/src/openapi-generator.ts

Contributing

We welcome contributions to oRPC! To get started, please review our contributing guidelines.