forge-kit

Forge Kit

License: MIT Quarkus Conventional Commits Commitizen friendly

CI/CD Workflows for Forge Kit

00 🧩 Hygiene checks
01 🚧 Build and test
02 πŸ‘ŠπŸ½ Auto version bump
03 πŸ“¦ Publish packages
50 πŸ”Ž Static analysis
51 πŸ”Ž Code coverage
codecov


Overview

Forge Kit is a collection of production-grade infrastructure components extracted directly from the Forge Platformβ€”battle-tested building blocks for building secure, observable, and resilient backend services.

Forge Kit focuses on horizontal concernsβ€”the infrastructure every serious service needsβ€”without prescribing business logic, workflows, or domain models.

Forge Kit is intentionally opinionated where it matters (security, observability, testability) and deliberately unopinionated where it should be.


What Forge Kit Provides

πŸ”’ Security & Protection

πŸ“ˆ Observability

🧱 Platform Utilities

Each module is independently usable and documented.


What Forge Kit Is Not

Forge Kit is not a full platform. It does not include:

Forge Kit solves how to build reliable servicesβ€”not what those services do.


Why Forge Kit Exists

Teams repeatedly re-implement foundational infrastructure with small variations, accumulating hidden risk that only surfaces under load or failure.

Forge Kit distills:

The result is infrastructure code you can trust, understand, and extend.


Repository Structure

forge-kit/
β”œβ”€β”€ forge-api/              # Annotations and contracts
    β”œβ”€β”€ forge-common-api/
    β”œβ”€β”€ forge-metrics-api/
    β”œβ”€β”€ forge-security-api/ 
    β”œβ”€β”€ forge-throttle-api/ 
β”œβ”€β”€ forge-impl/             # Implementations
    β”œβ”€β”€ forge-common/           # Common utilities and helpers
    β”œβ”€β”€ forge-health/           # Health check implementations
    β”œβ”€β”€ forge-metrics/          # Metrics and observability
    β”œβ”€β”€ forge-security/         # Metrics and observability
    β”œβ”€β”€ forge-throttle/         # Rate limiting and throttling
β”œβ”€β”€ examples/               # Usage examples and patterns
β”œβ”€β”€ templates/              # Configuration templates
└── docs/                   # Architecture Decision Records (ADRs)

Getting Started

Add the required modules to your project:

<dependency>
  <groupId>io.forge</groupId>
  <artifactId>forge-throttle</artifactId>
  <version>1.0.0</version>
</dependency>

Each module includes focused documentation and examples.

πŸ“š Documentation


Quality Gates

Forge Kit enforces strict quality gates in CI to ensure production readiness:

All checks must pass before release artifacts are published.

πŸ“„ See Code Quality & CI Enforcement for full details.


Relationship to the Forge Platform

Forge Kit is a foundational subset of the Forge Platform.

The Forge Platform builds on these same components to provide a fully integrated system, including:

In short:

Feature Forge Kit Forge Platform
Infrastructure primitives βœ… βœ…
Domain services ❌ βœ…
Multi-tenant SaaS ❌ βœ…
Security orchestration ❌ βœ…
Operational maturity ❌ βœ…
Commercial support ❌ βœ…

Forge Kit answers: β€œHow should we build this correctly?”
Forge Platform answers: β€œDo we need to build this at all?”


Architecture Decision Records (ADRs)

πŸ“˜ View Architecture Decision Records


Who Should Use Forge Kit

Forge Kit is a good fit if you:

If your primary goal is time-to-market rather than infrastructure ownership πŸ‘‰ Forge Platform may be a better fit.


Support & Commercial Offering

Forge Kit is open-source and community-supported.

For teams looking to accelerate delivery with a fully integrated platform built on these same foundations, learn more about the πŸ‘‰ Forge Platform.

Commercial inquiries and architecture discussions:

Andrew Eells
Forge Platform
[Contact Information]


License

Forge Kit is licensed under the MIT License.


Built with ❀️ by the Forge Platform team