Setup

Requirements

• Docker
• uv
• api key: Webshare

General Setup

1. create an .env file from the .env.example contents
2. Build and start the Docker container: this will restart the docker compose file and create the entire project including mysql-database & kafka-queue

   make docker-restart

   or if you want to exec into a debug container and run the code

   make docker-dev-restart

Other Setup

Web Scraper

1. Generate an API key from Webshare.

2. Copy the contents of .env.example to a new .env file.

3. Replace <api key> in the .env file with your API key:

   PROXY_API_KEY="<api key>"

The Polylith Architecture

Overview

The Polylith architecture is a modular approach to organizing codebases, aimed at improving maintainability, reducing duplication, and providing better oversight of projects. It is particularly well-suited for managing large, complex applications.

Why Use Polylith?

1. Reduce Duplication: With many repositories, schemas and functionalities are often replicated, leading to inconsistencies and maintenance challenges. Polylith consolidates shared code into reusable components.
2. Improve Oversight: Managing multiple repositories can obscure the overall project structure. Polylith centralizes the architecture, making it easier to navigate and understand.
3. Streamline Onboarding: New developers can quickly understand the project structure without needing to navigate numerous repositories.

Documentation

For an in-depth guide on Polylith architecture, visit the Polylith Documentation.

Commands

Below are the essential commands for working with Polylith in your project.

Create a Base

A base serves as the foundation for your architecture, often containing shared logic or configurations.

uv run poly create base --name <base_name>

Create a Component

A component is a reusable, self-contained module that encapsulates specific functionality.

uv run poly create component --name <component_name>

Create a Project

A project is the entry point for your application, built using the base and components.

uv run poly create project --name <project_name>