https://github.com/yonatankarp/xkcd-data-hub
An over engineered project to fetch XKCD comics from their RSS api and serve it to a client with nice functionality
https://github.com/yonatankarp/xkcd-data-hub
docker docker-compose elasticsearch kafka koin kotlin ktor microservice openapi postgresql spring-boot
Last synced: 23 days ago
JSON representation
An over engineered project to fetch XKCD comics from their RSS api and serve it to a client with nice functionality
- Host: GitHub
- URL: https://github.com/yonatankarp/xkcd-data-hub
- Owner: yonatankarp
- Created: 2024-05-25T12:14:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-12-18T20:17:28.000Z (about 2 months ago)
- Last Synced: 2025-12-20T11:09:48.787Z (about 2 months ago)
- Topics: docker, docker-compose, elasticsearch, kafka, koin, kotlin, ktor, microservice, openapi, postgresql, spring-boot
- Language: Kotlin
- Homepage:
- Size: 695 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/codeowners
Awesome Lists containing this project
README
# XKCD Data Hub
Welcome to the XKCD Data Hub! 👋
Imagine fetching your favorite XKCD comics, streaming them to a service that
neatly organizes everything using some cool engineering tricks, and then serving
it all up to your eager fingertips. That's what this project is all about! 🎉
## Features
- Fetch the latest XKCD comic information.
- Stream data to a projection service using CQRS and the outbox pattern.
- Serve data from an Event Store to the client.
- Easy setup and deployment using Docker Compose.
## Table of Contents
1. [Setup and Installation](#setup-and-installation)
2. [Architecture](#architecture)
## Setup and Installation
### Prerequisites
- Docker and Docker Compose
- JDK 21 or higher
- Kotlin 2.0 or higher
- Gradle build system
### Steps to Run the Project Locally
1. **Clone the Repository:**
```sh
$ git clone https://github.com/yonatankarp/xkcd-data-hub.git
$ cd xkcd-data-hub
$ git submodule update --init --recursive
```
2. **Build the Project:**
```sh
./gradlew build
```
3. **Run the Infrastructure using Docker Compose:**
```sh
docker-compose up -d
```
This will start all the necessary infrastructure including databases,
message brokers, and any other related components.
### Architecture
The project contains multiple submodules. Here's a brief overview of each:
* [Gateway](./gateway/README) - A facade for the client application to interact
with.
* [Fetcher](./fetcher/README) - Built using ktor, collects information about
XKCD comics, and streams it to the projection service.
* [Data Processor](./data-processor/README) - stores and serves XKCD comic data
to clients.
* [Client Application](./client-app/README) - provides a user interface to
interact with the XKCD data via API.
### Target Architecture
The following diagram describes the end goal of this repository:
