Creating an application from template

Project directory

Let’s take a closer look at the files inside the <app_name>/ directory:

• Application files:

  • app/roles/custom-role.lua: a sample custom role with a simple HTTP API. Can be enabled as app.roles.custom.
  • <app_name>-scm-1.rockspec: contains application dependencies.
  • init.lua: application entry point.
  • stateboard.init.lua application stateboard entry point.

• Build and packaging files:

  • cartridge.pre-build
  • cartridge.post-build
  • Dockerfile.build.cartridge
  • Dockerfile.cartridge

  To learn more, check the documentation on pre-build and post-build scripts, building your application with Docker, and creating a Docker image of your application.

• Development files:

  • deps.sh resolves dependencies listed in the .rockspec file and installs test dependencies (like luatest).
  • instances.yml contains the configuration of instances and is used by cartridge start.
  • .cartridge.yml contains the Cartridge configuration and is also used by cartridge start.
  • systemd-unit-params.yml contains systemd parameters.
  • tmp is a directory for temporary files used as a run directory (see .cartridge.yml).
  • .git is the directory responsible for the Git repository.
  • .gitignore is a file where you can specify the files for Git to ignore.

• Test files (with sample tests):

test
├── helper
│   ├── integration.lua
│   └── unit.lua
│   ├── helper.lua
│   ├── integration
│   │   └── api_test.lua
│   └── unit
│       └── sample_test.lua

• Configuration files:
  • .luacheckrc
  • .luacov
  • .editorconfig

Using a custom template

By default, create uses a standard template named cartridge. However, you can also make a custom template. To create an application from it, run cartridge create with the --from flag, specifying the path to your template.

If the template directory is a Git repository, all files in the .git directory will be ignored upon instantiating the template. Instead, a new git repo will be initialized for the newly created application.

Don’t include the .rocks directory in your template application. To specify application dependencies, use the .rockspec and cartridge.pre-build files.

my-template
├── {{ .Name }}-scm-1.rockspec
└── init.lua
└── stateboard.init.lua
└── test
    └── sample_test.lua

print("Hi, I am {{ .Name }} application")
print("I also have a stateboard named {{ .StateboardName }}")