Skip to main content

Directory structure

Takomo project's directory structure looks like this.

├─ stacks
├─ templates
├─ helpers
├─ partials
├─ resolvers
├─ hooks
├─ schemas
├─ deployment
└─ config-sets

There are two mandatory directories: stacks and templates. The stacks directory will contain all configuration files for your stacks, and the templates directory is where you'll place template files for the stacks.

You can find the purpose of each directory from the table below.

stacksConfiguration files for stacks. You can create subdirectories to organize stacks and to provide common configuration. Takomo treats each subdirectory as a stack group, You can provide configuration for a stack group by placing a config.yml file into its directory.
templatesCloudFormation template files that can be referenced from the stack configuration files. You can use subdirectories to organize template files.
helpersCustom Handlebars helpers. You can use helpers in stack configuration and template files.
partialsHandlebars partial files. You can include partial files in stack configuration and template files.
resolversCustom resolvers
hooksCustom hooks.
schemasCustom Joi schemas
deploymentConfiguration for deployment targets
config-setsConfig sets