Skip to content

Latest commit

 

History

History
104 lines (66 loc) · 3.72 KB

PREREQUISITES.md

File metadata and controls

104 lines (66 loc) · 3.72 KB
Raw

Prerequisites

Please have the following software on your computer before the workshop. If everyone is downloading the software at once, it will slow everyone down, and we want to make the most of our time together.

A Modern Computer

Please make sure you have a computer that is modern. No running windows 95, 7 or something funky from the year 2000. Make sure you have plenty of FREE RAM (at least 4gb) and with a modern processor (at least an i5). Most of the hiccups in trainings are when people do not meet the appropriate requirements in their own machines. We will be running CFML engines and docker containers, so make sure you can run them.

Windows PRO

If you are in Windows you will need Windows PRO and not Windows Home in order for Docker Desktop to be installed. We will be using Docker for our data services so you MUST be able to install and run docker containers.

Ignore this if you are using WSL2 which is supported with docker as well.

RESTFul Client

You will need a restful client for making requests. There are many, here are some:

Git

Java JDK 21

Version 17 (CFML) or 21 BoxLang

CommandBox CLI (Version 6.*)

Docker

You will need Docker Desktop installed so we can run the database and be able to deploy our API as a docker container. Once installed please issue the following commands to have our images ready in your machine:

docker pull mysql:8
docker pull ortussolutions/commandbox

That's it!

CommandBox Modules

Once CommandBox is installed we will need to install some global modules. Start by opening a box shell by typing box. Once in the shell you can type:

install commandbox-dotenv,commandbox-migrations,commandbox-cfformat,commandbox-cfconfig

MySQL Server (8)

You need to have a running MySQL Server version 8 locally or use a provided Docker Compose file during the workshop.

If you don't have one already on your system, you can get started easily with Docker or download MySQL for your operating system.

MySQL Client

You will want a SQL client to inspect and interact with your database. You can use any client you would like. Here are a few we like ourselves:

IDE

We recommend the following IDEs for development for this workshop

If using VS Code, please install the following extensions:

  • BoxLang
  • vscode-coldbox
  • vscode-testbox
  • Docker
  • Yaml

If using Sublime, please install the following extensions:

  • ColdBox Platform
  • CFML
  • CFMLDocPlugin
  • Enhanced HTML and CFML
  • DockerFile Syntax Highlighting
  • Yaml

Useful Resources