Skip to content

Latest commit

 

History

History
81 lines (49 loc) · 5.15 KB

README.md

File metadata and controls

81 lines (49 loc) · 5.15 KB
Raw

ОБЯЗАТЕЛЬНО К ПРОЧТЕНИЮ!!!

Добро пожаловать в репозиторий проекта финатлон!

Наш проект - фулл-стек проект на js.

##############################################################################################################################################################################

Состав сборки:

- Next JS

- React JS

- Apollo GraphQL client

- Material UI

- Styled Components

P: Возможны дополнения

##############################################################################################################################################################################

Данный проект построен по архитектуре Features Slices Design (FSD):

└── src/
    ├── app/ (Логика приложения)
    ├── pages/ (Страницы приложения)
    ├── widgets/ (Самостоятельные и полноценные блоки для страниц (PageTemplate, Profile и др.))
    ├── features/ (Обрабатываемые пользовательские сценарии)
    ├── enteties/ (Бизнес-сущности, которыми оперирует предметная область )
    └── shared/ (Переиспользуемые модули и компоненты, без привязки к бизнес-логике (пользователь, комментарий, общие прототипы и тп.))

Согласно данной архитектуре:

  1. Вы НЕ можете в компоненте из папки вызывать компонент из папки выше по иерархии
  2. Каждый элемент подлежит декомпозиции на меньшие составляющие
  3. Следует использовать для каждого компонента Public API (файл, экспортирующий необходимые модули и не позволяющий экспортировать другие)

ОБЯЗАТЕЛЬНО!!! Ознакомьтесь с инструкциями к архитектуре, если еще с ней не знакомы!

##############################################################################################################################################################################

Перед запском проекта на своем компьютере:

1. Пропишите в терминал:

npm ci

Данная команда подтянет модули и позволит выполнять дополнительные команды

2. ПЕРЕКЛЮЧИТЕСЬ НА СВОЮ ВЕТКУ ДЛЯ РАБОТЫ!

Работать ОБЯЗАТЕЛЬНО на своей ветке, чтобы ваши изменения не помешали работать другим участникам команды, а так же не "сломали" общий репозиторий!

##############################################################################################################################################################################

Команды для работы с проектом:

Запускает проект на локальном сервере в режиме разработки. Позволит следить за изменениями в коде в режиме реального времени.

npm run dev

Запускает сборщик проекта. Позволяет получить минифицированную сборку для деплоя на сервер.

npm run build

Корректно сработает ТОЛЬКО после билда. Позволяет на локалхосте посмотреть работу собранной версии проекта.

npm run start

##############################################################################################################################################################################

!!!ВНИМАНИЕ!!!

Каждое воскресенье до 20:00 вы обязаны зафиксировать все рабочие изменения на своих ветках и отправить PR (Pull Request)!

Сделать это можно в интерфейсе GitHub Desktop или по клику кнопки на сайте репозитория.

Каждый понедельник после 8:00 вы обязаны подтянуть изменения с main ветки на свою, чтобы продолжить комфортную работу!

Убедитесь, что вы находитесь на своей ветке при помощи команды: git branch
Подтянуть изменения с основной ветки: git pull --rebase origin main

##############################################################################################################################################################################