Playlistr: Setup

To get started you'll need CommandBox installed and MySQL as your database.

CommandBox

The best way to get started with a ColdBox application is to fire up CommandBox in your terminal, command line or shell.

  • cd into the directory you want to build the app in. We've chosen playlistr
  • Fire up CommandBox
  • Install the ColdBox framework
  • Create a skeleton ColdBox app
  • Then we need to install the CommandBox module commandbox-migrations to help us with the creation of our database tables.
  • To allow commandbox-migrations to interact with your database we need to tell it where it is and how to connect to it. We use a local .env file for that purpose. The module commandbox-dotenv provides that support so we need to install that as well. More on our .env file later.
$ mkdir playlistr
$ cd playlistr
$ box


______                                          ______
/ ____/___  ____ ___  ____ ___  ____ _____  ____/ / __ )____  _  __
/ /   / __ \/ __ `__ \/ __ `__ \/ __ `/ __ \/ __  / __  / __ \| |/_/
/ /___/ /_/ / / / / / / / / / / / /_/ / / / / /_/ / /_/ / /_/ />  <
\____/\____/_/ /_/ /_/_/ /_/ /_/\__,_/_/ /_/\__,_/_____/\____/_/|_| (R)  v4.0.0+01015

Computers are good at following instructions, but not at reading your mind.

Welcome to CommandBox!
CommandBox:playlistr>install coldbox
CommandBox:playlistr>coldbox create app playlistr
CommandBox:playlistr>install commandbox-migrations
CommandBox:playlistr>install commandbox-dotenv

In addition to this description of the process there is a GitHub repository of the code needed to reproduce this product. To be able to follow along in stages there are a number of branch releases. Each branch will be highlighted in this documentation like so:

Note: By default the ColdBox skeleton apps gitignore the framework and modules directories. Therefore when you checkout a branch release remember to install --force to pull down and install all the dependencies that are in the box.json at that point.