Klink

Klink is a bookmark-sharing and link aggregation platform where users can post and vote on links.

About

This project was created as a learning experience to further develop and practice my understanding of microservices. While I took efforts to adhere to best practices, there are likely areas where things could be improved.

The project exists as a monorepo for the sake of simplicity, but (per the microservice architecture) each service is sufficiently independent that it could be extracted into its own repository. Similarly, there is unifying top-level Docker compose file that orchestrates the deployment of all services. In a real-world production environment, each service would likely be deployed independently (usually orchestrated through something like Kubernetes) and they have been designed in such a way that this would be possible.

Architecture

This project is designed using a microservice architecture, implementing both EDA and REST APIs for communication between services. The project is divided into separate services, each responsible for a specific functionality of the application. These services include:

• User Service (FastAPI & SQLAlchemy + PostgreSQL): Handles CRUD operations related to users.
• Auth Service (FastAPI): Handles user authentication, authorization, and identification via JWT issuance and validation.
• Post Service (Go + SQLite): Handles CRUD operations related to posts.
• Gateway Service (Go): Serves as the main entry point for the application. It is responsible for routing client requests to the appropriate service.
• RabbitMQ: Used for asynchronous communication between services.
• Postman: A collection of Postman tests used for E2E and integration testing.
• Fluentd: Used for centralized logging.

Deployment

1. Build the base image needed to install local modules containing shared code (schemas): docker build -t klink:base . --no-cache
2. Optionally create a custom docker-compose.yml based on docker-compose.test-services.yml to override environment variables.
3. Start up the services: docker compose -f ./docker-compose.test-services.yml up

License

This project is open source under the MIT license.