Merge pull request #46 from qase-tms/doc/update-readme

Doc/update readme

README.md

@@ -4,3 +4,48 @@ A system for animal shelters, providing an easy and free way for shelter owners
 - [board to work on](https://github.com/orgs/qase-tms/projects/5/views/1)
 - [meta page](https://meta.shelterpaws.org)
 - [website](https://shelterpaws.org)
+
+## Режим разработки
+
+Перед тем, как закоммитить изменения, необходимо установить зависимости:
+
+```
+yarn install
+```
+
+### Возможные проблемы
+
+#### Found incompatible module.
+
+Для успешной установки всех зависимостей желательно использовать **node >=18.12.0**. Для переключения между версиями node можно воспользоваться [nvm](https://github.com/nvm-sh/nvm).
+
+#### fatal: cannot exec '.husky/pre-commit': No such file or directory
+
+1. Скопировать содержимое файла `.husky/pre-commit`:
+
+```
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn precommit
+```
+
+2. Удалить файл `.husky/pre-commit`
+
+3. Создать пустой `.husky/pre-commit` и вставить туда скопированный код.
+
+4. Запустить команду `npx husky install`
+
+5. Попробовать еще раз сделать коммит.
+
+Если данная инструкция не решила проблему, можно обойти проверку, используя флаг `--no-verify`:
+
+```
+git commit -m 'commit name' --no-verify
+```
+
+Перед тем, как закоммитить изменения с флагом `--no-verify`, рекомендуется запустить проверки вручную и исправить ошибки, если они есть:
+
+```
+yarn stylelint
+```

frontend/README.md

@@ -14,19 +14,25 @@ $ yarn install
 $ gulp
 ```
 Live server автоматически запустится по адресу `http://localhost:3000/`.
-Результат компиляции располагается в папке /testing/.
 Базовая директория live server: `testing`. Путь к нужному файлу строим от неё.
 Пример: `http://localhost:3000/index/index.html`
 
-Требования:
+### Требования:
 
 - Именования классов согласно БЭМ
 - Классы модификаторы имеют вид `.block--modifier`
 
-Полезные ссылки:
+### Возможные проблемы
+
+#### command not found: gulp
+
+Gulp должен быть установлен глобально:
+
+```
+yarn add global gulp
+```
+
+### Полезные ссылки:
 
 - [Документация nunjucks](https://mozilla.github.io/nunjucks/templating.html) - шаблонизатор, который используется в сборке
 - Для подсветки кода в `.njk` шаблонах можно использовать [расширение для vscode](https://marketplace.visualstudio.com/items?itemName=ronnidc.nunjucks)
-
-Примечания:
-- Для успешной установки всех зависимостей желательно использовать **node >=18.12.0**. Для переключения между версиями node можно воспользоваться [nvm](https://github.com/nvm-sh/nvm).