Skip to content

README.md

Latest commit

 

History

History
131 lines (98 loc) · 4.49 KB

README.md

File metadata and controls

131 lines (98 loc) · 4.49 KB
Raw

Catalyst Forge

A comprehensive developer platform that powers intelligent deployments and project management for Project Catalyst.

Catalyst Forge is a custom developer platform that provides intelligent deployment capabilities, project management, and CI/CD automation. It's designed as a multi-project monorepo containing several discrete components that work together to provide a comprehensive development and deployment platform.

🎯 Purpose

Catalyst Forge enables developers to:

  • Deploy applications with intelligent, GitOps-style automation
  • Manage projects through a unified CLI and API
  • Automate CI/CD with custom GitHub Actions and workflows
  • Configure infrastructure using CUE-based blueprints and KCL modules
  • Orchestrate containers with Kubernetes operators and custom resources

🚀 Quick Start

Prerequisites

  • Go 1.21+
  • Docker
  • Kubernetes cluster (for deployment features)
  • GitHub account (for CI/CD features)

Installation

# Clone the repository
git clone https://github.com/your-org/catalyst-forge.git
cd catalyst-forge

# Build the CLI
cd cli
go build -o forge ./cmd

# Run a basic command
./forge --help

Basic Usage

# Scan a project for blueprints
./forge scan blueprint /path/to/project

# Run an Earthfile target
./forge run +my-target

📦 What's Included

Core Components

  • CLI (cli/) - Command-line interface for project management and deployments
  • Foundry (foundry/) - API server and Kubernetes operator for intelligent deployments
  • Libraries (lib/) - Shared Go libraries for project management and external integrations
  • Actions (actions/) - Custom GitHub Actions for CI/CD automation
  • Modules (modules/) - KCL-based deployment modules for Kubernetes manifests

Documentation & Resources

  • Documentation (docs/) - User guides, tutorials, and API reference
  • Examples (modules/examples/) - Sample deployments and usage patterns
  • Schemas (lib/schema/) - CUE-based configuration schemas

📋 Requirements

Development Environment

  • Go 1.21+ - Primary development language
  • Docker - Container runtime and builds
  • Earthly - Build system and execution engine
  • Kubernetes - Container orchestration (for deployment features)

External Services

  • GitHub - Source control and CI/CD integration
  • AWS - Cloud infrastructure (ECR, S3, Secrets Manager)
  • PostgreSQL - Database for API server (optional)

🔧 Technology Stack

Core Technologies

  • Go - CLI, API server, and Kubernetes operator
  • CUE - Configuration and schema language
  • KCL - Kubernetes Configuration Language for modules
  • Earthly - Build system and execution engine
  • Kubernetes - Container orchestration platform

External Integrations

  • GitHub - Source control and CI/CD
  • AWS - Cloud infrastructure services
  • PostgreSQL - Database for API persistence

📚 Documentation

Getting Started

Reference

Development

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details on:

  • Setting up your development environment
  • Code style and standards
  • Testing requirements
  • Pull request process

📄 License

This project is dual licensed under:

🔗 Related Projects

  • Project Catalyst - The platform powered by Catalyst Forge
  • Earthly - Build system used by Catalyst Forge
  • CUE - Configuration language for blueprints
  • KCL - Kubernetes Configuration Language for modules