Skip to content

A modern, fluent and conventions based HMVC framework for BoxLang and CFML

License

Notifications You must be signed in to change notification settings

ColdBox/coldbox-platform

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation


ColdBox Snapshots Total Downloads Latest Stable Version Apache2 License

Copyright Since 2005 ColdBox Platform by Luis Majano and Ortus Solutions, Corp
www.coldbox.org | www.ortussolutions.com


Because of God's grace, this project exists. If you don't like this, then don't read it, it's not for you.

"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ: By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God. And not only so, but we glory in tribulations also: knowing that tribulation worketh patience; And patience, experience; and experience, hope: And hope maketh not ashamed; because the love of God is shed abroad in our hearts by the Holy Ghost which is given unto us. ." Romans 5:5


Welcome to ColdBox HMVC Platform

ColdBox is the de-facto enterprise-level HMVC (Hierarchical Model-View-Controller) framework designed for two powerful programming languages:

  • BoxLang - A modern JVM language owned and directed by the ColdBox team
  • CFML (ColdFusion) - Legacy support for existing enterprise applications

Built for scalability, modularity, and developer productivity, ColdBox eliminates the complexity of modern web development through conventions over configuration and a comprehensive ecosystem of integrated tools.

πŸ† Proven & Professional

19+ Years of Excellence - Since 2006, ColdBox has been battle-tested in enterprise environments worldwide, evolving with modern development practices and industry standards.

Professional Open Source - Backed by Ortus Solutions, ColdBox provides the reliability and support that businesses demand. With dedicated full-time development, comprehensive documentation, and professional services, enterprises can confidently build mission-critical applications on ColdBox.

Enterprise Ready - Trusted by Fortune 500 companies and organizations globally, ColdBox delivers the stability, performance, and long-term support that enterprise applications require. Learn more at www.coldbox.org.

πŸš€ Why Choose ColdBox?

Modern Web Development Made Simple

  • Zero Configuration: Get started immediately with sensible defaults
  • Convention-Based: Write less boilerplate, focus on business logic
  • Enterprise Ready: 19+ years proven, professionally backed by Ortus Solutions
  • Full-Stack Framework: Everything you need in one cohesive platform and module ecosystem

Powerful Features

πŸ“š Documentation

We have made a firm commitment to our community that our Documentation will always be complete and up to date. We have have a dedicated team that works full time on keeping the documentation accurate and relevant, with over 20 years of delivering quality documentation to the community.

Comprehensive documentation is available at: https://coldbox.ortusbooks.com

Quick Links

⚑ Quick Start

1. Install ColdBox CLI (Essential Tool)

The ColdBox CLI is essential for ColdBox development:

# Install CommandBox (if not already installed)
# Visit: https://www.ortussolutions.com/products/commandbox

# Install ColdBox CLI globally
box install coldbox-cli

2. Create Your First Application

# Generate a new ColdBox application
coldbox create app MyApp --template=Advanced

# Navigate to your app
cd MyApp

# Start the development server
box server start

3. Explore Starter Templates

Choose from production-ready templates at https://github.com/coldbox-templates:

# Default application template
coldbox create app MyDefaultApp

# REST API template
coldbox create app MyAPI skeleton=rest

# BoxLang application template
coldbox create app MyApp skeleton=boxlang

# Microservice template
coldbox create app MyService skeleton=rest-hmvc

πŸ’Ύ Installation Options

CommandBox (Recommended)

# Stable Release
box install coldbox

# Bleeding Edge (Auto-updated from commits)
box install coldbox@be

ForgeBox Software Directory

Visit ForgeBox for additional installation options.

πŸ› οΈ VS Code Development Tools

Enhance your ColdBox development experience with our official VS Code extensions:

ColdBox Extension

Download from VS Code Marketplace | Open VSX Registry

Features:

  • ColdBox application scaffolding
  • Handler, model, and view generators
  • Built-in ColdBox commands integration
  • Project templates and snippets
  • Syntax highlighting for ColdBox conventions

BoxLang Developer Pack

Download from VS Code Marketplace | Open VSX Registry

Complete development suite including:

  • BoxLang language server with IntelliSense
  • Syntax highlighting and code formatting
  • Integrated debugging capabilities
  • CFML compatibility layer
  • Advanced code completion and navigation

πŸ—οΈ Architecture Overview

ColdBox provides four integrated subsystems:

🌐 ColdBox MVC Core

  • Modern HMVC architecture
  • Convention-based routing
  • Event-driven request lifecycle
  • Built-in security features

πŸ’‰ WireBox - Dependency Injection

  • Powerful IoC container
  • AOP (Aspect-Oriented Programming)
  • Object lifecycle management
  • Auto-discovery and registration

⚑ CacheBox - Enterprise Caching

  • Multi-provider architecture
  • Distributed caching support
  • Cache regions and policies
  • Built-in cache providers

πŸ“Š LogBox - Structured Logging

  • Multiple appender support
  • Configurable log levels
  • Structured logging patterns
  • Performance optimized

πŸ”§ Standalone Library Support

Use Independently - WireBox, CacheBox, and LogBox are designed as standalone libraries that can be used in ANY BoxLang or CFML application without requiring the full ColdBox framework. This modular architecture allows you to:

  • Integrate WireBox for dependency injection in existing applications
  • Add CacheBox for enterprise caching to legacy systems
  • Implement LogBox for structured logging in any project
  • Mix and match components based on your specific needs

Each library maintains its own documentation and can be installed independently via CommandBox.

πŸ”„ Long Term Support (LTS)

ColdBox follows a predictable release cycle with extensive support:

Version Release Bug Fixes Until Security Fixes Until
6.x 2022 2024 2025
7.x 2023 2025 2026
8.x 2025 2026 2027
9.x 2026 2027 2028

πŸ’» System Requirements

Supported Languages & Engines

BoxLang (Recommended)

  • BoxLang 1.0+
  • Modern JVM language with enhanced performance
  • Owned and directed by the ColdBox team

CFML Support

  • Adobe ColdFusion 2023+
  • Lucee 5.0+
  • Legacy application support

🀝 Contributing & Community

Get Involved

Development Setup

# Clone the repository
git clone https://github.com/ColdBox/coldbox-platform.git
cd coldbox-platform

# Install dependencies
box install

# Start development server
box server start

# Run test suites
box run-script tests:integration

🌟 Ecosystem

ColdBox powers a rich ecosystem:

Core Libraries (Standalone Compatible)

  • WireBox DI - Dependency injection for any BoxLang/CFML app
  • CacheBox - Enterprise caching for any BoxLang/CFML app
  • LogBox - Structured logging for any BoxLang/CFML app

Extended Ecosystem

πŸ“„ License

Apache License, Version 2.0 - See LICENSE file for details.

The ColdBox websites, logos and content have separate licensing and are separate entities.

πŸ”— Important Links

Source Code

Documentation

Issue Tracking

Official Sites


THE DAILY BREAD

"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12

Sponsor this project

Packages

No packages published

Contributors 85