grpc-ts-demo - GitLite

KO | EN

gitlite — search

#ai #android #rust #deep-learning #docker #macos #nodejs #java #awesome-list #pytorch #security #ios #mcp #open-source

grpc-ts-demo

(★ 121)

🎵 Demo of a gRPC client and server implementation in TypeScript

File Explorer

Download Latest Version (.zip)

- dependabot.yml
- songs.proto
- build-protos.sh
- - add-songs.ts
  - client.ts
  - get-chat.ts
  - get-song.ts
  - live-chat.ts
- - songs_grpc_pb.d.ts
  - songs_grpc_pb.js
  - songs_pb.d.ts
  - songs_pb.js
- - add-song.ts
  - db.ts
  - get-chat.ts
  - get-song.ts
  - index.ts
  - live-chat.ts
- index.ts
.eslintignore
.eslintrc
.gitignore
.prettierrc
LICENSE.md
package.json
README.md
tsconfig.json
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/blokur/grpc-ts-demo

Downloads the entire project code from GitHub to your computer.

cd grpc-ts-demo

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

yarn

Downloads and installs the libraries listed in package.json.

yarn clean

Type this command into your terminal and run it.

yarn build

Builds optimized production files.

yarn start serve

Starts the development/run server.

yarn start get-song

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# grpc-ts-demo

🎵 Music-themed demo of a _fully typed_ gRPC client and server implementation in TypeScript. It implements each RPC type (unary, client streaming, server streaming and bidirectional), and uses type definitions generated with [`grpc_tools_node_protoc_ts`](https://github.com/agreatfool/grpc_tools_node_protoc_ts).

![gRPC TypeScript](https://blokur-public.s3-eu-west-1.amazonaws.com/images/grpc-typescript.png)

The demo application takes the form of a CLI tool that allows you to manage and discuss your favourite songs. [Watch demo](https://blokur-public.s3-eu-west-1.amazonaws.com/videos/grpc-ts-demo.mp4).

Read the accompanying blog post [here]().

[![Watch Demo](https://blokur-public.s3-eu-west-1.amazonaws.com/images/grpc-ts-demo-screenshot.png)](https://blokur-public.s3-eu-west-1.amazonaws.com/videos/grpc-ts-demo.mp4)

## Install

```sh
yarn
yarn clean
yarn build
```

## Usage

### Start the server

```sh
yarn start serve
```

### [Unary](https://grpc.io/docs/guides/concepts/#unary-rpc): Get a random song

```sh
yarn start get-song
```

### [Client Streaming](https://grpc.io/docs/guides/concepts/#client-streaming-rpc): Add songs

```sh
yarn start add-songs
```

The songs you add will be persisted to the local JSON store `db.json`.

### [Server Streaming](https://grpc.io/docs/guides/concepts/#server-streaming-rpc): Get chat comments on a song

```sh
yarn start get-chat --songId <id>
```

### [Bidirectional Streaming](https://grpc.io/docs/guides/concepts/#bidirectional-streaming-rpc): Live chat on a song

```sh
yarn start chat
```

Say you set your username as `mike` and you choose to discuss the song with id `10`. Then, the application will dump chat messages to a local file called `chat-mike-10.txt`. You can observe messages as they come in:

```sh
watch cat chat-mike-10.txt
```

Go ahead and try running multiple chat clients at once!