Skip to content

Репозиторий для разработки фронтенд части проекта "Document Template Engine"

Notifications You must be signed in to change notification settings

document-template-engine/frontend

Repository files navigation

Шаблонизатор документов. Frontend

В данном репозитории находится frontend-часть веб-приложения шаблонизатора документов "Doky".

Наш стэк: React.js, Redux, SASS, Storybook, Prettier, Lint-staged, Husky, ESLint, Commitizen

Разработчики: Давыденков Иван, Леонова Екатерина, Костюкова Екатерина, Султангалиев Рустам, Шершнёв Павел.

Ex-разработчики: Чепурина Елизавета, Шашков Дмитрий, Явьян Михаил.

Инструкция для новых разработчиков и тех, кто хочет поближе познакомиться с проектом

Как локально развернуть проект:

  1. Проект скачивается локально в отдельную папку через git clone.
    Рекомендуем перед этим обновить версию Node.js как минимум до 18.
    git clone git@github.com:document-template-engine/frontend.git
  2. Необходимо локально установить зависимости из проекта.
    npm i
  3. В режиме разработки приложение откроется на 3000 порту после введения этой команды:
    npm run start

Как работать над задачей:

  1. Подтянуть актуальные изменения из ветки develop.
    git pull origin develop.
  2. Создать отдельную ветку. Название ветки должно отражать функционал.
    Например:
  • Feature - разработка новой фичи. Feature/Header - разработка компонента header.
  • Fix - дебагинг и всевозможные фиксы кода. Fix/Header - ветка для починки компонента header.
    git checkout -b feature/header
  1. Когда задача выполнена, необходимо сохранить изменения и закоммитить их с сообщением. Сообщение отражает суть разработки.
    git add -A
    git commit -m "создан компонент header"
  2. Перед отправкой кода в общий репозиторий необходимо вновь подтянуть актуальные изменения.
    git pull --rebase origin develop
    Обратите внимание, эта команда не сработает, если в вашей ветке есть несохраненные изменения.
  3. Если возникли конфликты, их необходимо решить локально в редакторе кода.
  4. После успешного коммита необходимо запушить изменения в свою ветку.
    git push -u origin *название ветки*
  5. После успешного пуша необходимо создать пул-реквест из своей ветки в ветку develop. В 9/10 случаев gitHub автоматически предоложит это сделать, нажав на соответствующую кнопку.
  6. Скинуть ссылку на пул-реквест в беседу разработчиков.

About

Репозиторий для разработки фронтенд части проекта "Document Template Engine"

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 11