https://github.com/julien-r44/tuyau
RPC / E2E Client For AdonisJS
https://github.com/julien-r44/tuyau
adonisjs e2e-client rpc-client typesafety ziggy
Last synced: 6 months ago
JSON representation
RPC / E2E Client For AdonisJS
- Host: GitHub
- URL: https://github.com/julien-r44/tuyau
- Owner: Julien-R44
- License: mit
- Created: 2024-03-24T12:26:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-07T11:39:04.000Z (7 months ago)
- Last Synced: 2025-04-02T17:15:17.518Z (7 months ago)
- Topics: adonisjs, e2e-client, rpc-client, typesafety, ziggy
- Language: TypeScript
- Homepage: https://tuyau.julr.dev
- Size: 1.24 MB
- Stars: 146
- Watchers: 1
- Forks: 8
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Pronounced as "twee-yo" (IPA: /tɥijo/). French word for "pipe" or "tube"
# Tuyau
Set of tools to create typesafe APIs using AdonisJS. The monorepo includes the following packages:
- `@tuyau/core` : Core package that you must install in your AdonisJS project.
- `@tuyau/utils` : Set of utilities and helpers for the other packages.
- `@tuyau/client` : E2E typesafe client to consume your AdonisJS APIs.
- `@tuyau/inertia` : Set of components and helpers for AdonisJS + Inertia projects.
- `@tuyau/openapi` : Experimental package to generate a "not-so-bad" OpenAPI definition from your AdonisJS project based on the Tuyau codegen.
- `@tuyau/superjson` : Make [SuperJSON](https://github.com/flightcontrolhq/superjson) works seamlessly with Tuyau and AdonisJS.
See documentation at [tuyau.julr.dev](https://tuyau.julr.dev).
## Goals of the project
The main goal of this project is to provide some utilities to have better typesafety when creating APIs with AdonisJS. Goals on the long term are :
- **Done** : Provide an RPC-like client that is fully e2e typesafe ( like tRPC, Elysia Eden, Hono etc. )
- **Done** : Provide a [Ziggy](https://github.com/tighten/ziggy)-like helper to generate and use routes in the frontend.
- **Done (Experimental)** : Having an automatic OpenAPI generation + Swagger/Scalar UI viewer based on Tuyau codegen.
- **Done** : Provide some Inertia helpers to have better typesafety when using Inertia in your AdonisJS project. Things like typesafe ``.
- **Not started**: Having a Tanstack-Query integration for the client package. Like [tRPC](https://trpc.io/docs/client/react) or [ts-rest](https://ts-rest.com/docs/vue-query) does.
## Sponsors
If you like this project, [please consider supporting it by sponsoring it](https://github.com/sponsors/Julien-R44/). It will help a lot to maintain and improve it. Thanks a lot !
