eWizard CLI creates the files and directories within your module 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/ | ├─blocks-library/ | | └─blocks.json | ├─components/ | | └─components.json | ├─i18n/ | | └─localization.json | ├─media/ | | ├─fonts/ | | ├─images/ | | ├─pdfs/ | | ├─signature/ | | └─videos/ | ├─resources/ | | └─references.json | └─styles/ | └─main.css ├─extensions/ | └─common.js ├─node_modules/ ├─themes/ ├─.eslintrc.js ├─.gitignore ├─App.vue ├─icon.png ├─index.html ├─package.json ├─package-lock.json ├─preview.jpg ├─readme.md └─settings.json
Let's take a closer look at the directories and files.
The project directory structure may differ depending on the selected project template and initialization options.
Source file or directory | Description |
| Specifies the project template type, the path configuration for all the directories, plugin settings, and the template repository. |
| Stores the compiled project source files. This directory appears after you run the |
| The JavaScript bundle created upon the development build. This file is referenced in |
| The JavaScript bundle used in eWizard Editor. |
| The project's JavaScript :Entrypoint:entrypoint: created upon the development build. This file is referenced in |
| Stores all changes applied to the project in eWizard Editor. |
| Contains all common components, styles, localization, and media resources. |
| The directory is used only in the classic email projects to store the added blocks. |
| Contains blocks available for adding to the project in eWizard Editor. The |
| Stores local |
| Contains the list of components displayed in eWizard Editor. |
| Contains the localization files in the JSON format. |
| The localization of text used in the module template. |
| Stores the common media resources: fonts, images, PDF files, signature images, and videos. Each type of media resource is stored in its own directory. |
| The text in external documents that you can reference in the module. |
| Contains the common CSS styles. |
| Use |
| Stores the |
| The npm packages installed for the project. You can install the project dependencies with the |
| Contains themes for the project template. Each theme is in its own directory. The directory name is the same as its theme. |
| The ESLint configuration file with predefined settings for a vue-based project. You can turn off/on the plugin in |
| Specifies the files and directories that aren't synced with Git. |
| A :SingleFileComponent:singlefilecomponent: with the template where you add all the common components for your module. It contains 3 chunks of code: HTML, CSS, and JavaScript. |
| The main HTML file that serves as an entry point of the entire project to run the project as a single-page application. It includes the main project view and contains the JavaScript bundles that are produced by eWizard CLI. |
| Stores general information about the project and contains the list of project npm dependencies. |
| Provides the version information for all packages installed into |
| The preview icon of the generated module. |
| Stores useful development information and hints. |
| Specifies the project settings depending on the template type. For more information, see Module settings. |