Skip to content

Latest commit

 

History

History
119 lines (81 loc) · 6.38 KB

readme.md

File metadata and controls

119 lines (81 loc) · 6.38 KB


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


ColdBox Elixir Application Template

This template can be your starting ground for your modern ColdFusion (cfml) web applications. You must use CommandBox to track your dependencies and start embedded servers.

This template leverages ColdBox and the (ColdBox Elixir)[https://coldbox-elixir.ortusbooks.com] project for asset management and compilations. You can place all your static assets in the resources/assets folder and Elixir will combine, version, copy, and even babelify your code to their appropriate location in the includes folder.

Quick Installation

Install the template dependencies by running the install command:

box install

This will setup all the needed dependencies for each application template. You can then start the embedded server:

box server start

Code to your liking and enjoy!

Java Dependencies

If your project relies on Java third-party dependencies, you can use the included Maven pom.xml file in the root. You can add your dependencies there and then run the mvn install command to download them into the lib/java folder. The ColdBox application will automatically class load all the jars in that folder for you! You can also use the mvn clean command to remove all the jars.

You can find Java dependencies here: https://central.sonatype.com/. Just grab the Maven coordinates and add them to your pom.xml file.

Dockerfile

We have included a build/Dockerfile so you can build docker containers from your source code. We have also added two scripts in your box.json so you can build the docker image and run the docker image using our CommandBox Docker containers.

# Build a docker **container**
run-script docker:build
# Run the container
run-script docker:run
# Go into the container's bash prompt
run-script docker:bash

Docker Compose Stack

We have included a build/docker-compose.yaml stack that can be used to run the application in a container alongside a database. We have included support for MySQL, PostgreSQL and MSSQL. We have also included the run-script docker:stack command you so you compose the stack up or down.

run-script docker:stack up
run-script docker:stack down

VSCode Helpers

We have included two vscode helpers for you:

  • .vscode/settings.json - Includes introspection helpers for ColdBox and TestBox
  • .vscode/tasks.json - Tasks to assist in running a Test Bundle and a CommandBox Task

We have included two custom tasks:

  • Run CommandBox Task - Open a CommandBox task and run it
  • Run TestBox Bundle - Open the bundle you want to test and then run it

To run the custom tasks open the command palette and choose Tasks: Run Build Task or the shortcut ⇧⌘B

Welcome to ColdBox

ColdBox Hierarchical MVC is the de-facto enterprise-level HMVC framework for ColdFusion (CFML) developers. It's professionally backed, conventions-based, modular, highly extensible, and productive. Getting started with ColdBox is quick and painless. ColdBox takes the pain out of development by giving you a standardized methodology for modern ColdFusion (CFML) development with features such as:

Learning ColdBox

ColdBox is the defacto standard for building modern ColdFusion (CFML) applications. It has the most extensive documentation of all modern web application frameworks.

If you don't like reading so much, then you can try our video learning platform: CFCasts (www.cfcasts.com)

ColdBox Sponsors

ColdBox is a professional open-source project and it is completely funded by the community and Ortus Solutions, Corp. Ortus Patreons get many benefits like a cfcasts account, a FORGEBOX Pro account and so much more. If you are interested in becoming a sponsor, please visit our patronage page: https://patreon.com/ortussolutions

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