eWizard CLI creates the files and directories within your e-Detailer 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 | └─templates.js ├─common/ | ├─blocks/ | ├─blocks-library/ | ├─components/ | | └─components.json | ├─i18n/ | | ├─common.json | | └─references.json | ├─media/ | | ├─fonts/ | | ├─images/ | | ├─pdfs/ | | └─videos/ | └─styles/ | ├─fonts.css | ├─import.css | ├─main.css | └─theme.css ├─extensions/ | ├─globalComponents.js | └─store.js ├─node_modules/ ├─slides/ | └─default/ | ├─media/ | | └─images/ | └─index.vue ├─store/ | ├─actions.js | ├─mutations.js | └─index.js ├─themes/ ├─.eslintrc.js ├─.gitignore ├─App.vue ├─icon.png ├─icon@2x.png ├─index.html ├─package-lock.json ├─package.json ├─readme.md ├─settings.json └─structure.json
Let's take a closer look at the directories and files.
WARNING: The project directory struсture may differ depending on the selected project template and initialization options.
Source file or directory | Description |
| The |
| Stores the compiled project source files. This directory appears only after you run the |
| The JavaScript bundle that is created when you run the development build. This file is referenced in |
| The JavaScript bundle that is used in eWizard Ultimate Performance Editor. |
| The project's JavaScript entry point that is created when you run the development build. This file is referenced in |
| The JavaScript bundle that is used in eWizard Ultimate Performance Editor. The bundle displays slides from the master template. |
| Contains all common components, styles, localization, and media resources. |
| The directory is used only in the classic email projects to store the added blocks. |
| The directory is used in the email projects. In the classic emails, this is a library of blocks displayed in the Editor. You can add these blocks to your email. In the Ultimate Performance emails, the |
| Stores local |
| Contains the list of components to be displayed in the eWizard Ultimate Performance Editor sidebar. |
| Contains localization files in the JSON format. |
| Global localization of text on all slides. Eliminates the need to localize the same text on individual slides. |
| The text in external documents that you can reference in the slides. |
| Stores the common media resources: fonts, images, PDF files, and videos. Each type of media resource is stored in its own directory. |
| Contains the common styles. |
| Use |
| Use |
| Use |
| Imports all stylesheets on the same level that supplies common styles for the entire project. |
| Stores the |
| The npm packages installed for the project. You can install the project dependencies by running the |
| Contains the slides directories in which slide appearance and logic are defined in the |
| This directory is present if you select the |
| Exports the |
| Designed to store |
| Designed to store |
| 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 are not synced with Git. |
| A Single File Component where you add all the common components for your slides (menu, footer, logo). It contains 3 chunks of code: HTML, CSS, and JavaScript. |
| 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 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 |
| Stores useful development information and hints. |
| Specifies the project settings depending on the template type. See e-Detailer settings. |
| Specifies the e-Detailer struсture and the slides display order. |
*[Single File Component]: A style of application organization used by JavaScript UI libraries where each file represents a single component.
*[entry point]: An entry point indicates which module webpack should use to begin building out its internal dependency graph.