From 8e114b23be02adbaf74f08d82a9e4c6b4f22e69b Mon Sep 17 00:00:00 2001 From: Kirill Date: Tue, 10 Jan 2023 12:19:48 +0300 Subject: [PATCH] docs: nodejs commands --- README.md | 6 +++++- commands/nodejs/README.md | 27 +++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 commands/nodejs/README.md diff --git a/README.md b/README.md index 995fb86..5b8f82f 100644 --- a/README.md +++ b/README.md @@ -13,4 +13,8 @@ ## Swagger: -- [**Информация о swagger'е**](./swagger/README.md) \ No newline at end of file +- [**Информация о swagger'е**](./swagger/README.md) + +## Комманды: + +- [**Комманды сервисов NodeJS**](./commands/nodejs/README.md) \ No newline at end of file diff --git a/commands/nodejs/README.md b/commands/nodejs/README.md new file mode 100644 index 0000000..6673178 --- /dev/null +++ b/commands/nodejs/README.md @@ -0,0 +1,27 @@ +# Комманды сервисов / микросервисов на NodeJS + +Для работы используется пакетный менеджер: **`yarn`** + +## Список комманд: + +``` +1) yarn setup - загрузка всех зависимостей и инициализация husky +2) yarn dev - запуск проекта в режиме разработки +3) yarn start - запуск проекта +4) yarn test - запуск тестов +5) yarn test:watch - запуск тестов в режиме просмотра изменений +6) yarn build - сборка приложения +7) yarn lint - проверка качества кода linter'ом +8) yarn code:format - форматирование кода prettier'ом +9) yarn code:check - проверка кода prettier'ом +``` + +## Примечание: + +В первую очередь, перед началом работы в проекте, необходимо выполнить команду: + +``` +yarn setup +``` + +Она установит все зависимости в проект и настроит `husky` \ No newline at end of file