# Website boilerplate

### Node version should be at least >=16.14.0 <=20.18.0

## Boilerplate structure description
- `config/` - build configuration folder.
- `config/tasks` - all gulp tasks located here.
- `config/helpers` - all ENV constants and project helpers located here.
---
- `src/` - all development files must be located in this folder.
- `src/components` - all project components must be located in this folder.
- `src/image` - project images must be located in this folder.
- `src/media` - project media files must be located in this folder.
- `src/js` - project javascript files must be located in this folder.
- `src/scss` - project scss (styles) files must be located in this folder.
- `src/templates` - project page templates and main partials must be located in this folder.
---
- `dist/` - the built project will be located in this folder.

## Configuration
- `config/config.js` - project build configuration.
- `config/config-export.js` - project export configuration, for example export project assets to CMS.
- `.editorconfig` - editor configuration.
- `.stylelintrc` - styles linter configuration.

## Commands
- `npm i --legacy-peer-deps` - install all needed packages and plugins
- `npm start` - starts build process and run local server, it will compile pages for standard package.
- `npm run build` - build project in production mode.
- `npm run build:gitlab` - build project in production mode for gitlab.
- `npm run export` - export project files according export configuration.