Create Package

To begin, you need an installation of Apex. The best and most preferred method is the four line install. In any Linux or MacOS terminal simply run the following commands:

git clone
cd apex && mv install_example.yml install.yml
docker-compose up -d
docker-compose exec apex apex

Otherwise, please consult the Installation section of the documentation for full details on how to complete an installation of Apex.

If you did a Docker installation, please note you may access the bash prompt to execute all apex commands outlined in this tutorial by running the following command:

docker-compose exec apex bash

Create Project

Upon a successfful installation of Apex, we first need to create a new package. Run the following command in terminal:

apex package create disaster

This will create the following new directories:

Directory Description
/etc/Disaster Configuration files and database migrations
/docs/Disaster Public facing documentation.
/src/Disaster Source code for the package.
/tests/Disaster Unit tests for the package.

Aside from the /etc/Disaster directory, you will notice the other directories are empty. Although Apex does provide loads of tools to aid in your software development, it also provides as much flexibility as possible allowing you to develop in any style and design you prefer. The /src/Diaster/ drectory is blank for a reason, as it's your blank canvas to develop in any manner you desire.