|
| 1 | +<div align="center"> |
| 2 | + <br/> |
| 3 | + <img src="./assets/logo.svg" alt="doofpi" width="80" /> |
| 4 | + <h1>doofpi</h1> |
| 5 | + <p><strong>Edge-First TypeScript API Framework</strong></p> |
| 6 | + |
| 7 | + <p> |
| 8 | + <a href="https://www.npmjs.com/package/doofpi"><img src="https://img.shields.io/npm/v/doofpi.svg" alt="npm version" /></a> |
| 9 | + |
| 10 | + <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-orange.svg" alt="MIT License" /></a> |
| 11 | + </p> |
| 12 | + |
| 13 | + <p> |
| 14 | + <a href="https://liorcodev.github.io/doofpi-docs/docs/quick-start"><strong>Quick Start</strong></a> · |
| 15 | + <a href="https://liorcodev.github.io/doofpi-docs/docs/core-concepts/read-and-write"><strong>Core Concepts</strong></a> · |
| 16 | + <a href="https://liorcodev.github.io/doofpi-docs/docs/api-reference/doofpi-class"><strong>API Reference</strong></a> · |
| 17 | + <a href="https://liorcodev.github.io/doofpi-docs"><strong>Documentation →</strong></a> |
| 18 | + </p> |
| 19 | + <br/> |
| 20 | +</div> |
| 21 | + |
| 22 | +--- |
| 23 | + |
| 24 | +**doofpi** is a lightweight TypeScript framework based on web standards for building end-to-end type-safe APIs - no code |
| 25 | +generation, no build steps, no separate schema files to maintain |
| 26 | + |
| 27 | +```bash |
| 28 | +# Core install |
| 29 | +bun install doofpi |
| 30 | + |
| 31 | +npm install doofpi |
| 32 | + |
| 33 | +pnpm install doofpi |
| 34 | +``` |
| 35 | + |
| 36 | +> **Optional:** Add `zod` for schema validation and type inference from schemas. |
| 37 | +> |
| 38 | +> ```bash |
| 39 | +> bun install doofpi zod |
| 40 | +> ``` |
| 41 | +
|
| 42 | +## Highlights |
| 43 | +
|
| 44 | +| | | |
| 45 | +| -------------------------- | ----------------------------------------------------------- | |
| 46 | +| **Zero Boilerplate** | No adapters, links, or transformers minimal setup | |
| 47 | +| **End-to-End Type Safety** | Change your server, your client breaks at compile time | |
| 48 | +| **Runtime Agnostic** | Bun · Cloudflare Workers · Vercel · Netlify · Deno and more | |
| 49 | +| **Zod Validation** | Optional input _and_ output validation at runtime | |
| 50 | +| **Web Standards** | Built on the native `Request` / `Response` API | |
| 51 | +| **Thoroughly Tested** | 100% code coverage across all core features | |
| 52 | +
|
| 53 | +## Documentation |
| 54 | +
|
| 55 | +Full documentation, guides, and API reference are available at |
| 56 | +**[liorcodev.github.io/doofpi-docs](https://liorcodev.github.io/doofpi-docs)**. |
| 57 | +
|
| 58 | +| | | |
| 59 | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------ | |
| 60 | +| [Quick Start](https://liorcodev.github.io/doofpi-docs/docs/quick-start) | Get up and running in minutes | |
| 61 | +| [Core Concepts](https://liorcodev.github.io/doofpi-docs/docs/core-concepts/read-and-write) | Read & Write semantics, routing, Zod validation | |
| 62 | +| [Guides](https://liorcodev.github.io/doofpi-docs/docs/guides/context-and-middleware) | Context, middleware, error handling, and more | |
| 63 | +| [API Reference](https://liorcodev.github.io/doofpi-docs/docs/api-reference/doofpi-class) | Full API for `Doofpi`, `EndpointBuilder`, and `createClient` | |
| 64 | +| [Comparison](https://liorcodev.github.io/doofpi-docs/docs/comparison) | How doofpi compares to tRPC | |
| 65 | +
|
| 66 | +## Acknowledgments |
| 67 | +
|
| 68 | +Inspired by [tRPC](https://trpc.io). |
| 69 | +
|
| 70 | +--- |
| 71 | +
|
| 72 | +<div align="center"> |
| 73 | + <sub>MIT License · Built with ❤️ for the TypeScript community</sub> |
| 74 | +</div> |
0 commit comments