Directory Structure

A generated Maze app has a number of auto-generated files and folders that make up the structure of an Maze application.

When you use the maze new command to create your application, it creates the entire directory structure for the application, because of this Maze knows where to find the files it needs within this structure, so you don't have to provide additional input.

File Folder

Purpose

config/

Contains configuration code for initializers, environments, routing, and deployment

db/

Contains database seeds and migrations.

lib/

Contains local installation of all dependent shards

public/

Location for html, css, and javscripts. This will be the default directory for static assets.

spec/

Location for application specification and tests

src/

Source code that composes your application

.encryption_key

This file is used to encrypt application secrets so they are not stored in source control

.maze.yml

This file is generate for Maze CLI and contains settings for the command line tools

package.json

Maze utilizes Webpack and NPM to compile static assets

.gitignore

This file tells git which files and patterns it should ignore.

docker-compose.yml

A file which defines services, networking, and drives for docker deployment.

Dockerfile

A file which contains all the commands needed to build a docker image.

README.md

A brief instruction manual about your application

Last updated