Getting started

Configuration files

This section outlines the configuration files available in your project. These files are crucial for managing and customizing the build system, ensuring that the development environment is tailored to meet specific requirements.

Configuration files overview

File name Description
build/config.js This file serves as the main input file where paths, file names, and other configurations are specified. It defines essential paths such as HTML, SCSS, JS source, and output directories, along with specific configurations for assets like icons and vendor files. If you change the fileNames for JS and CSS or any source folder names (like scss: 'src/scss', src_js: 'src/js') in this configuration, ensure to update the references in the source files accordingly: src/scss/new-file-name.scss and src/js/new-file-name.js. Additionally, any folder name changes must be reflected in the project structure and related paths. This will ensure the build system functions correctly.
package.json Manages the project's metadata, scripts, and dependencies, serving as a manifest file for Node.js projects. Essential for npm to identify the project's dependencies, scripts, and version info.
.editorconfig Helps maintain consistent coding styles for multiple developers working across various editors and IDEs. It supports a number of properties for setting indent style, charset, and more. For detailed configuration, visit the EditorConfig Documentation.
.gitignore Specifies files and directories that Git should ignore. Helps prevent unneeded files from being committed to your repository.
manifest.json Used to store metadata about your web application as part of its web app manifest, which is crucial for defining how your app appears when installed on a user's device.
Top