https://github.com/emanuelefavero/trpc
This is a cheat sheet repo for tRPC, a library for building typesafe APIs between server and client
https://github.com/emanuelefavero/trpc
client nodejs trpc typescript
Last synced: 6 months ago
JSON representation
This is a cheat sheet repo for tRPC, a library for building typesafe APIs between server and client
- Host: GitHub
- URL: https://github.com/emanuelefavero/trpc
- Owner: emanuelefavero
- License: mit
- Created: 2023-02-09T00:01:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-09T10:58:40.000Z (over 2 years ago)
- Last Synced: 2025-02-04T16:50:28.027Z (8 months ago)
- Topics: client, nodejs, trpc, typescript
- Language: TypeScript
- Homepage:
- Size: 11.6 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# tRPC
This is a cheat sheet repo for tRPC, a library for building typesafe APIs between server and client
> Note: tRPC main features work with TypeScript
---
## Table of Contents
- [Installation](#installation)
- [Running](#running)
- [Setup a new project](#setup-a-new-project)
- [Setup server folder](#setup-server-folder)
- [Setup client folder](#setup-client-folder)
- [Resources](#resources)
- [License](#license)
---
## Installation
- clone repo and `cd` into it
- `cd` into `server` and run `npm install`
- `cd` into `client` and run `npm install`
## Running
- `cd` into `server` and run `npm run dev`
- `cd` into `client` and run `npm run dev`
- visit `http://localhost:5173/` to see the client
---
## Setup a new project
tRPC works well when you have a monorepo with a `server` and `client` folder on the same levelf
> Note: you can setup a new tRPC project with [create-t3-app](https://create.t3.gg/)
OR
### Setup server folder
- run `npm i @trpc/server cors express zod`
- run `npm i -D @types/cors @types/express @types/node nodemon ts-node typescript`
- setup `typescript` with `tsc --init`
- add `dev` script to `package.json`:
```json
"dev": "nodemon SERVER_NAME.ts"
```
- start developing your server
> Note: see this repo project for a working example
### Setup client folder
> Note: You can use many frameworks as the client, but tRPC works best with t3, Next.js and React
- run `npm i @trpc/client`
- run `npm i -D typescript`
- setup `typescript` with `tsc --init`
- add `dev` script to `package.json`:
```json
"dev": "YOUR CLIENT START COMMAND"
```
- start developing your client
> Note: see this repo project for a working example
---
## Resources
- [tRPC.io](https://trpc.io/)
- [tRPC Docs](https://trpc.io/docs)
- [tRPC Quickstart](https://trpc.io/docs/quickstart)
- [create-t3-app](https://create.t3.gg/)
## License
- [MIT](LICENSE.md)
---
[**Go To Top ⬆️**](#trpc)