Skip to main content
All CollectionseWizard.js frameworkEmails
eWizard.js: email directory struсture
eWizard.js: email directory struсture

Learn more about the struсture of the scaffolding template directory

eWizard Team avatar
Written by eWizard Team
Updated over a year ago

eWizard CLI creates the files and directories within your email project directory.


TIP: The eWizard.js project has a robust directory struсture. We strongly recommend sticking to it during the development process.


.
├─.ewizard/
|  └─settings.json
├─build/
|  └─dev/
|    ├─app.js
|    ├─editor.js
|    ├─index.js
|    └─state.js
├─common/
|  ├─blocks/
|  |  └─readme.md
|  ├─blocks-library/
|  |  └─blocks.json
|  ├─components/
|  |  └─components.json
|  ├─i18n/
|  |  └─localization.json
|  ├─media/
|  |  ├─fonts/
|  |  ├─images/
|  |  ├─pdfs/
|  |  ├─signature/
|  |  └─videos/
|  └─styles/
|     └─main.css
├─extensions/
|  └─common.js
├─node_modules/
├─themes/
├─.gitignore
├─App.vue
├─icon.png
├─index.html
├─package.json
├─package-lock.json
├─preview.jpg
├─readme.md
└─settings.json

WARNING: The project directory structure may differ depending on the selected project template and initialization options.


Source file or directory

Description

.ewizard/settings.json

Specifies the project template type, the path configuration for all the directories, plugin settings, and the template repository.

build/dev/

Stores the compiled project source files. This directory appears after you run the wiz dev command.

build/dev/app.js

The JavaScript bundle created upon the development build. This file is referenced in index.html.

build/dev/editor.js

The JavaScript bundle used in eWizard Editor.

build/dev/index.js

The project's JavaScript

entry point

created upon the development build. This file is referenced in index.html.

build/dev/state.js

Stores all changes applied to the project in eWizard Editor.

common/

Contains all common components, styles, localization, and media resources.

common/blocks/

Stores local blocks.

common/blocks-library/

Contains blocks available for adding to the project in eWizard Editor.

common/components/

Stores local Vue components files.

common/components/components.json

Contains the list of components displayed on the eWizard Editor Components panel.

common/i18n/localization.json

Contains localizations in the email.

common/media/

Contains the common media resources—fonts, images, PDF files, signature, videos—stored in the dedicated directories.

common/styles/main.css

Stores common styles for the project.

extensions/common.js

Stores the project common components registered globally.

node_modules/

The npm packages installed for the project. You can install the project dependencies by running the wiz install command.

themes/

Contains the project template themes stored in the dedicated directories. The directory name is the same as its theme. For more information, see Dynamic themes in emails.

.gitignore

Specifies intentionally untracked files and directories that Git must ignore.

App.vue

Contains the email template markup.

icon.png

The default project icon in your eWizard account.

index.html

The main HTML file that serves as an entry point of the entire project and allows you to run the project as a single-page application. It includes the main project view and contains the JavaScript bundles produced by eWizard CLI.

package.json

Stores the general information about the project and contains the list of the project npm dependencies.

package-lock.json

An automatically generated file for tracking versions of all packages installed into node_modules by the npm client.

preview.jpg

The created project preview.

readme.md

Contains the project description, useful development information, and hints.

settings.json

Specifies the project settings depending on the template type.

Did this answer your question?