From 6eb9973b613b91983fd9e3ca1cf388ef01d90f11 Mon Sep 17 00:00:00 2001 From: vbuglov Date: Fri, 22 Mar 2024 14:17:24 +0300 Subject: [PATCH] upd documentation --- README.md | 31 ++++++- repo/0-documentations/Docker.md | 8 ++ repo/0-documentations/HistoryTest.md | 44 ++++++++++ repo/0-documentations/Readme.md | 102 ---------------------- repo/0-documentations/Verdaccio.md | 47 ++++++++++ repo/1-toolkits-helpers/Readme.md | 4 +- repo/3-class-complex-assistants/Readme.md | 4 +- repo/Readme.md | 16 ++++ 8 files changed, 151 insertions(+), 105 deletions(-) diff --git a/README.md b/README.md index a05f81c..c4e0434 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ -### Пуш приложений \ No newline at end of file +# Репозиторий фронтенд приложений + +* Репозиторий будет переименован. microapps-admin-vue -> frontend-apps + +## Приложения: +* live_monitor_vue - приложение калькулятора +* proxy-ui-app - приложение управления роутерами на сайтах и сайтами +* users-manage - приложение управления пользователями +* [repo](./repo/Readme.md) - Репозиторий пакетов + +### Установка пакета +* Для того чтобы установить пакет из репозитория, необходимо указать путь к пакету. Путь может быть абсолютным или относительным. Путь указывается к папке, содержащей файл `package.json`. Путь указывается относительно файла, в котором выполняется команда установки. + +```bash + npm install ../path/to/mymodule + yarn ../path/to/mymodule +``` + +### Пример установки пакета +#### *Установка хэлперов* +* Для установки хэлперов необходимо выполнить команду установки пакета. Пакеты хэлперов находятся в папке `1-toolkits-helpers`. + +```bash +yarn add "~/Projects/microapps-admin-vue/repo/1-toolkits-helpers/" +... +or +... +yarn add "../repo/1-toolkits-helpers/" +``` + diff --git a/repo/0-documentations/Docker.md b/repo/0-documentations/Docker.md index e69de29..27ba7af 100644 --- a/repo/0-documentations/Docker.md +++ b/repo/0-documentations/Docker.md @@ -0,0 +1,8 @@ +# Установщики и пакеты +## Установка Docker +* sudo apt install apt-transport-https ca-certificates curl software-properties-common +* curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - +* sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable" +* apt-cache policy docker-ce +* sudo apt install docker-ce +* sudo systemctl status docker diff --git a/repo/0-documentations/HistoryTest.md b/repo/0-documentations/HistoryTest.md index e69de29..ca2b79b 100644 --- a/repo/0-documentations/HistoryTest.md +++ b/repo/0-documentations/HistoryTest.md @@ -0,0 +1,44 @@ +## History 1 +* docker login cr.selcloud.ru +* docker login -u token -p CRgAAAAAsYBrOCPNnU4w5lpyWvBUqBJZc10Zx2Vk cr.selcloud.ru/test +* docker pull cr.selcloud.ru/test/serverx:v0.0.1 +* ls +* docker images +* docker run ca9acef541e4 +* docker run -p 8080:80 ca9acef541e4 +* history +* exit +* ssh-keygen -t rsa +* ssh-copy-id root@31.41.155.24 +* ssh 'root@31.41.155.24' +* cat .ssh/id_rsa +* history + +## History 2 +* 1 exit +* 2 sudo apt install apt-transport-https ca-certificates curl software-properties-common +* 3 curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - +* 4 sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable" +* 5 apt-cache policy docker-ce +* 6 sudo apt install docker-ce +* 7 sudo systemctl status docker +* 8 docker ps +* 9 docker login cr.selcloud.ru +* 10 docker login -u token -p CRgAAAAAh1ym3ZjMpOFRRiZUeVgVRTDWe2a-Xjaa cr.selcloud.ru/learn-registry +* 11 docker pull cr.selcloud.ru/learn-registry/learnbuild:v0.0.1 +* 12 ls +* 13 docker images +* 14 docker run -d -p 4040:80 --rm --name cr.selcloud.ru/learn-registry/learnbuild cr.selcloud.ru/learn-registry/learnbuild +* 15 docker run -d -p 4040:80 --rm 8e7dfb4cfe29 +* 16 $ ssh-keygen -t rsa +* 17 ssh-keygen -t rsa +* 18 ls +* 19 ls .ssh/ +* 20 cd .ssh/id_rsa +* 21 cat .ssh/id_rsa +* 22 ssh root@185.91.52.59 +* 23 docker ps +* 24 docker stop ff9cb826bbec +* 25 docker ps +* 26 cat .ssh/id_rsa +* 27 history \ No newline at end of file diff --git a/repo/0-documentations/Readme.md b/repo/0-documentations/Readme.md index d835262..385a71e 100644 --- a/repo/0-documentations/Readme.md +++ b/repo/0-documentations/Readme.md @@ -4,105 +4,3 @@ * Пакеты разделены на уровни в соотвествии с уровнем их абстракции. Цифра в начале названия пакета указывает на уровень абстракции. 0 - самый высокий уровень, 9 - самый низкий. * Пакет с высоким уровнем абстракции может использоваться ТОЛЬКО в пакетах с более низким уровнем абстракции. ![схема](./images/Схема.jpg) -# Установщики и пакеты -## Установка Docker -* sudo apt install apt-transport-https ca-certificates curl software-properties-common -* curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - -* sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable" -* apt-cache policy docker-ce -* sudo apt install docker-ce -* sudo systemctl status docker - -## Установка verdaccio -#### *требуются дополнительные настройки* -### Скачиваем образ -* docker pull verdaccio/verdaccio -### Запуск под docker volume -* docker volume create --name verdaccio-storage -* docker run -d --name verdaccio -p 4873:4873 --restart unless-stopped -v verdaccio-storage:/verdaccio verdaccio/verdaccio -### Volume в локальной папке -* mkdir verdaccio -* mkdir verdaccio/storage -* sudo chmod a+rwx ./verdaccio -* sudo chmod a+rwx ./verdaccio/storage -* docker run -d --name verdaccio -p 4873:4873 --restart unless-stopped -v /data/verdaccio/storage:/verdaccio/storage verdaccio/verdaccio - -## Работа с npm - -### Создать пользователя и зарегестрироваться -* npm adduser --registry https://vniac.ru:4873/ -* Пример login: vbuglov, password: *****, email: test@test.tets - -### Переключение регестри. -#### Будет работать только npm; yarn не чувствует авторизацтию -* npm set registry https://vniac.ru:4873/ -* yarn config set registry https://vniac.ru:4873/ (обычно не требуется) - -#### Вернуть регистри назад -* npm set registry https://registry.npmjs.org/ - -#### Установки из регистри -* npm install 5-test-package --registry=https://vniac.ru:4873/ - -## Создание npm auth token -* npm login --registry https://vniac.ru:4873/ -* npm token list --registry https://vniac.ru:4873/ -* npm token create --registry https://vniac.ru:4873/ - -## Публикация пакета -* npm config set registry http://$NPM_REGISTRY -* npm config set //$NPM_REGISTRY:_authToken=$NPM_TOKEN *(для работы из гита)* -* npm publish --tag latest - -## Публикация пакета из гитлаба -* npm config set registry https://vniac.ru:4873/ -* npm config set https://vniac.ru:4873:_authToken=d16uS0wqLkS97/E98V2pgtL3EY3C+0aThqUkrzIIhI4= -* npm publish --tag latest - -## Установка пакета из репозитория -* npm install 1-toolkits-helpers --registry=https://vniac.ru:4873/ - -## History 1 -* docker login cr.selcloud.ru -* docker login -u token -p CRgAAAAAsYBrOCPNnU4w5lpyWvBUqBJZc10Zx2Vk cr.selcloud.ru/test -* docker pull cr.selcloud.ru/test/serverx:v0.0.1 -* ls -* docker images -* docker run ca9acef541e4 -* docker run -p 8080:80 ca9acef541e4 -* history -* exit -* ssh-keygen -t rsa -* ssh-copy-id root@31.41.155.24 -* ssh 'root@31.41.155.24' -* cat .ssh/id_rsa -* history - -## History 2 -* 1 exit -* 2 sudo apt install apt-transport-https ca-certificates curl software-properties-common -* 3 curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - -* 4 sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable" -* 5 apt-cache policy docker-ce -* 6 sudo apt install docker-ce -* 7 sudo systemctl status docker -* 8 docker ps -* 9 docker login cr.selcloud.ru -* 10 docker login -u token -p CRgAAAAAh1ym3ZjMpOFRRiZUeVgVRTDWe2a-Xjaa cr.selcloud.ru/learn-registry -* 11 docker pull cr.selcloud.ru/learn-registry/learnbuild:v0.0.1 -* 12 ls -* 13 docker images -* 14 docker run -d -p 4040:80 --rm --name cr.selcloud.ru/learn-registry/learnbuild cr.selcloud.ru/learn-registry/learnbuild -* 15 docker run -d -p 4040:80 --rm 8e7dfb4cfe29 -* 16 $ ssh-keygen -t rsa -* 17 ssh-keygen -t rsa -* 18 ls -* 19 ls .ssh/ -* 20 cd .ssh/id_rsa -* 21 cat .ssh/id_rsa -* 22 ssh root@185.91.52.59 -* 23 docker ps -* 24 docker stop ff9cb826bbec -* 25 docker ps -* 26 cat .ssh/id_rsa -* 27 history diff --git a/repo/0-documentations/Verdaccio.md b/repo/0-documentations/Verdaccio.md index e69de29..0fb09f0 100644 --- a/repo/0-documentations/Verdaccio.md +++ b/repo/0-documentations/Verdaccio.md @@ -0,0 +1,47 @@ +## Работа с npm +### Создать пользователя и зарегестрироваться +* npm adduser --registry https://vniac.ru:4873/ +* Пример login: vbuglov, password: *****, email: test@test.tets + +### Переключение регестри. +#### Будет работать только npm; yarn не чувствует авторизацтию +* npm set registry https://vniac.ru:4873/ +* yarn config set registry https://vniac.ru:4873/ (обычно не требуется) + +#### Вернуть регистри назад +* npm set registry https://registry.npmjs.org/ + +## Установка verdaccio +#### *требуются дополнительные настройки* +### Скачиваем образ +* docker pull verdaccio/verdaccio +### Запуск под docker volume +* docker volume create --name verdaccio-storage +* docker run -d --name verdaccio -p 4873:4873 --restart unless-stopped -v verdaccio-storage:/verdaccio verdaccio/verdaccio +### Volume в локальной папке +* mkdir verdaccio +* mkdir verdaccio/storage +* sudo chmod a+rwx ./verdaccio +* sudo chmod a+rwx ./verdaccio/storage +* docker run -d --name verdaccio -p 4873:4873 --restart unless-stopped -v /data/verdaccio/storage:/verdaccio/storage verdaccio/verdaccio + +#### Установки из регистри +* npm install 5-test-package --registry=https://vniac.ru:4873/ + +## Создание npm auth token +* npm login --registry https://vniac.ru:4873/ +* npm token list --registry https://vniac.ru:4873/ +* npm token create --registry https://vniac.ru:4873/ + +## Публикация пакета +* npm config set registry http://$NPM_REGISTRY +* npm config set //$NPM_REGISTRY:_authToken=$NPM_TOKEN *(для работы из гита)* +* npm publish --tag latest + +## Публикация пакета из гитлаба +* npm config set registry https://vniac.ru:4873/ +* npm config set https://vniac.ru:4873:_authToken=d16uS0wqLkS97/E98V2pgtL3EY3C+0aThqUkrzIIhI4= +* npm publish --tag latest + +## Установка пакета из репозитория +* npm install 1-toolkits-helpers --registry=https://vniac.ru:4873/ diff --git a/repo/1-toolkits-helpers/Readme.md b/repo/1-toolkits-helpers/Readme.md index 9ae5bf5..1d2e84b 100644 --- a/repo/1-toolkits-helpers/Readme.md +++ b/repo/1-toolkits-helpers/Readme.md @@ -3,7 +3,9 @@ ## Описание * В данном репозитории собраны простые функции, которые могут пригодиться в разработке. Функции сгруппированны по сущностям, в соответствии с их назначением. ## Установка -npm install 1-toolkits-helpers --registry=https://vniac.ru:4873/ +```bash +yarn add "../repo/1-toolkits-helpers/" +``` ### Adapter * Часто используется для адаптации данных, полученных с сервера, к виду, который ожидает фронтенд. Например, переименование ключей, преобразование значений и т.д. diff --git a/repo/3-class-complex-assistants/Readme.md b/repo/3-class-complex-assistants/Readme.md index 1ccd4f4..c70b161 100644 --- a/repo/3-class-complex-assistants/Readme.md +++ b/repo/3-class-complex-assistants/Readme.md @@ -3,7 +3,9 @@ ## Описание * В данном репозитории собраны классы, которые помогают в разработке ## Установка -npm install 3-class-complex-assistants --registry=https://vniac.ru:4873/ +```bash +yarn add "../repo/3-class-complex-assistants" +``` ### Logger * Заменяет console.log, console.error, console.warn, console.info Отправляет логи на сервер, если передан url diff --git a/repo/Readme.md b/repo/Readme.md index e69de29..ff03c62 100644 --- a/repo/Readme.md +++ b/repo/Readme.md @@ -0,0 +1,16 @@ +# Репозиторий пакетов +## Описание +* Репозиторий локальный и содержит пакеты для установки. Пакеты могут быть установлены с помощью `npm` или `yarn`. Пакеты могут быть установлены из других проектов. + +### Установка пакета +* Для того чтобы установить пакет из репозитория, необходимо указать путь к пакету. Путь может быть абсолютным или относительным. Путь указывается к папке, содержащей файл `package.json`. Путь указывается относительно файла, в котором выполняется команда установки. + +```bash + npm install --save ../path/to/mymodule + yarn add "../path/to/mymodule" + yarn add "~/Projects/microapps-admin-vue/repo/1-toolkits-helpers/" + yarn add "../repo/1-toolkits-helpers/" +``` + + +[Документация по работе с пакетным менеджером](./0-documentations/Readme.md) \ No newline at end of file