new_project_starta v1.0.1

Сайт для застройщика "Гурус"

Основные команды в сборке

npm install - установить компоненты.

npm start - запустить локальную среду для разработки. Если возникают ошибки, читаем комментарии и смотрим, с чем конфликтует сборка. Как правило, обычно конфликты версий nodejs и npm с другими компонентами.

npm run build - запустить билд проекта. Скомпилированный проект располагается полностью только в папке dist.

Структура проекта

src/layouts - шаблоны проекта. По умолчанию один основной шаблон default.html

src/pages - страницы сайта

src/partials - куски HTML, которые могут использоваться в одном виде на разных страницах. Использовать обязательно, чтобы не плодить лишний код и не усложнять работу коллегам.

src/assets - общая папка с ассетами.

src/assets/scss - содержит все файлы стилей в формате scss. app.scss - это основной файл, который содержит в себе все включаемые стили. Внутри него никакие стили не пишем, а только подключаем дополнительные файлы. За основу берём пример с других подключённых фалов и добавляем по тому же принципу.

src/assets/scss/parts - сюда добавляем файлы стилей логически относящиеся к конкретным страницам или блокам. Пример, чтобы подключить стили для главной страницы, создаём здесь файл _index.scss и подключаем его в файл app.scss.

Оформление кода и прочие правила

• Названия страниц должны быть обязательно логичными, отражать суть содержимого, написаны на латинице с нижними подчеркивание в качестве проблеов
• В названиях классов и идентификаторов используем английский язык. Никакого транслита и выдуманных русско-английских слов ("Номер" или "Количество" это "number" и "count". Но никак не "nomer", не "numer", не "caunt" и не "kolichestvo"). Пользуемся онлайн-переводчиком, если есть проблемы со знанием английского.
• Составные названия классов разделяем нижним подчеркиванием и дефисом. В названиях классов не используем camelCase.

Совместная разработка

• Для каждой фичи создаём новую ветку из рабочей. Например, для вёрстки главной страницы одна ветка, для вёрстки шапки - вторая, для подвала - третья, для модалок - четвертая и т.д.
• Ветки мёржит и удаляет только руководитель проекта. Даже если у вас появились на это права, самостоятельно ничего не сводим и не объединяем.
• Название ветки должно отражать суть содержимого. Примеры названий, header, index_page, contacts_page и т.д.
• Коммиты должны писаться по принципу <Тип работ>: <Краткое описание выполненных работ> <Номер задачи в CRM>. Типы работ, как правило, это либо feat (разработка новой фичи или улучшение старой), либо fix (исправление багов, вёрстки и т.д.). Описание работ может быть указано по-русски. Номер задачи в CRM не является обязательным. Примеры коммитов: fix: Исправил размеры шрифтов в мобильной версии #33241516 , feat: Добавил модальное окно с формой авторизации.
• После выполнения задачи по своей ветке отправляем pull request в master (main) и оповещаем руководителя проекта.