Альфа

Конфигурация

Vue 3.5.17 Vite 7.0.3 TypeScript 5.8.3 Tailwind 4.1.11 ESLint: 9.34.0

Как развернуть шаблон локально?

Установить нужную версию Node.js:

Для корректной работы проекта необходимо иметь установленной одну из нижеперечисленных версий Node.js:

• v18.18.0 и выше
• v20.9.0 и выше
• v21 и выше

Клонировать проект

git@github.com:p0wered/alfa.git

Установить модули

npm install

Запустить локально

npm run dev

ESLint и Code Style

В проекте используется ESLint для поддержания чистоты и единообразности кода. Для того чтобы ESLint корректно работал внутри IDE необходимо сделать следующее:

В PhpStorm/WebStorm:

1. Перейти в настройках по пути Settings → Languages & Frameworks → JavaScript → Code Quality Tools → ESLint
2. Выбрать опцию Automatic ESLint Configuration
3. Перезагрузить IDE

В VS Code/Cursor:

1. Скачать плагины ESLint (dbaeumer.vscode-eslint) и Vue.js (Vue.volar)
2. Перезагрузить IDE

Правила с комментариями находятся в eslint.config.ts.

Стиль написания имен файлов:

• Vue компоненты - PascalCase
• Ассеты (svg, png, webp и т.д.) - kebab-case
• Файлы TypeScript, JavaScript, JSON и т.д. - kebab-case

Стиль написания кода:

Код должен проходить по правилам линтеров без ошибок, иначе команда npm run build и попытки залить изменения в гит будут отвергаться.

Код внутри тега script во всех файлах имеет один отступ. Делать это желательно, но необязательно, так как это моё личное предпочтение -_-

Также, импорты в проекте располагаются в особом порядке. Сначала переменные внутри { }, затем любые переменные, и только затем прочее (Vue компоненты, файлы стилей, медиа и т.д.). Это правило тоже носит рекомендательный характер.

Превью