@[org-name]/[application-name]

Выбор имени приложения

Прежде чем приступать к настройке репозитория, следует выбрать имя приложения.

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

, где каждый параметр, обернутый в

[]

это строка в нижнем регистре без пробелов (kebab-case). Например, для компании Cloud.ru

org-name

может быть

cloud-ru

.

При выполнении скрипта

из инструкции далее потребуется ввести выбранные значения

org-name

и

application-name

, а при регистрации готового сервиса в системе позже понадобится знание имени приложения

После выполнения инструкции имя приложения появится в

в поле

name

, а также в файле

README.md

на первой строке

Как создать своё приложение из шаблона

• Создайте репозиторий из шаблона
• Склонируйте себе на компьютер полученный репозиторий, запустите команду
  npm run init-app
• Поменяйте константы
  routeName
  ,
  port
  в секции
  config
  , а также
  homepage
  и
  repository
  в файле package.json
• Поправьте файл CODEOWNERS - добавьте туда ответственных за проект пользователей.
• Удалите секцию "Как создать своё приложение из шаблона" и "Выбор имени приложения" из README.md

После проделанных действий можно вносить специфические для вашего продукта изменения.

Общие данные с платформой (cloud-ru-api)

При работе платформы, на которую встраивается этот сервис, загружаются часть данных о пользователе и его действиях, например, идентификатор пользователя или выбранный в данный момент проект. Для получения доступа к этим данным необходимо воспользоваться пакетом cloud-ru-api (более подробно см README)

Использование общих компонентов

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

Подробную документацию и примеры использования компонентов смотрите в его README.

NPM Scripts

• start:https
  - development-сборка микрофронта, разворачивание на локальном сервере. Дополнительно должен быть установлен сертификат в папке на уровень выше проекта, например, если проект расположен в
  dev/my_project
  , то сертификат необходимо установить в
  dev
  .
• build
  - production-сборка бандла микрофронта.
• reinstall
  - удаление папки
  node_modules
  , файла
  package-lock.json
  , очистка
  npm cache
  . Необходима при подозрении на проблемы, связанные с коллизиями версий установленных пакетов.
• test:unit
  - запуск тестов, опция
  --passWithNoTests
  успешно прогоняет тесты, даже если в проекте их нет. При появлении тестов в проекте флаг следует удалить.
• tsc
  - проверка типов с помощью утилиты tsc.
• eslint:fix
  - применение стилизации к кодовой базе согласно настроенным правилам eslint-а.