Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imbenrabi/event-driven-architecture
Managed monorepo, that implements event driven flow using tRPC and Kafka.
https://github.com/imbenrabi/event-driven-architecture
chai commitlint docker docker-compose fasitfy husky kafdrop kafka kafkajs lint lint-staged mocha nyc pino sinon trpc vite zod
Last synced: about 2 months ago
JSON representation
Managed monorepo, that implements event driven flow using tRPC and Kafka.
- Host: GitHub
- URL: https://github.com/imbenrabi/event-driven-architecture
- Owner: imbenrabi
- Created: 2024-07-19T13:09:56.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-26T07:08:13.000Z (3 months ago)
- Last Synced: 2024-10-11T22:41:18.080Z (2 months ago)
- Topics: chai, commitlint, docker, docker-compose, fasitfy, husky, kafdrop, kafka, kafkajs, lint, lint-staged, mocha, nyc, pino, sinon, trpc, vite, zod
- Language: TypeScript
- Homepage:
- Size: 189 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Event-Driven Architecture with Fastify, tRPC, and Kafka
This project implements an event-driven architecture where events/messages are sent from a client to a Kafka queue via a tRPC server, and subsequently to an end provider/service. The project is organized in a monorepo and includes repository management tools such as lint, Husky, and Commitlint.
# Notable Technologies
- [**Vite**](https://vitejs.dev/)
- [**Docker**](https://www.docker.com/get-started)
- [**KafkaJS**](https://kafka.js.org/)
- [**Kafdrop**](https://github.com/obsidiandynamics/kafdrop)
- [**tRPC**](https://trpc.io/)
- [**Fastify**](https://www.fastify.io/)
- [**Zod**](https://zod.dev/)
- [**Pino**](https://github.com/pinojs/pino)
- [**Mocha**](https://mochajs.org/)
- [**Chai**](https://www.chaijs.com/)
- [**NYC**](https://github.com/istanbuljs/nyc)
- [**Sinon**](https://sinonjs.org/)
- [**Commitlint**](https://commitlint.js.org/)
- [**Husky**](https://typicode.github.io/husky/#/)
- [**Lint-staged**](https://github.com/okonet/lint-staged)
# Setting Up Kafka Using Docker
We'll use Docker to simplify the installation process.
## Prerequisites
1. **Docker**: Ensure Docker is installed on your machine. You can download it from [here](https://www.docker.com/get-started).
## Steps to Set Up Kafka locally
### 1. Run Zookeper and Kafka with Docker
In root, run:
```sh
docker compose up -d
```
# Running the project
### 1. Install Deps
Install project deps.
Go to root and run:
```sh
npm install
```
### 2. Run Kafka
Make sure Docker image is running succesfully.
Go to root and run:
```sh
npm run dev:kafka
```
The script will start a Kafka consumer that is using batching.
you can disable batching by setting `KAFKA_MESSAGE_BATCHING` env variable to `false`.
### 3. Run Server
Go to root and run:
```sh
npm run dev:server
```
### 4. Run client
Make sure server is running succesfully.
Go to root and run:
```sh
npm run dev:client
```
Go to [localhost](http://localhost:5173/).
# Checking results
### Go to Kafdrop - a Kafka UI Client
The Docker compose command installed and ran [Kafdrop](https://github.com/obsidiandynamics/kafdrop) image as well.
Go to [localhost:19000](http://localhost:19000) to review results.
# Tests
We are using [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/) for testing, alongside [nyc](https://github.com/istanbuljs/nyc) for HTML report.
## Running tests
From a specific package root, run:
```sh
npm run test
```
OR
From root, run:
```sh
npm run test:all
```
- You can also run per package - see package.json scripts.
## Running tests with coverage and opening the HTML report
From a specific package root, run:
```sh
npm run test:coverage:open
```
OR
from root, run:
```sh
npm run test:coverage:open:
```
For specific package.
OR
```sh
npm run test:coverage:open:all
```
For all packages.