{"id":14978608,"url":"https://github.com/anatoly-semenov/docs-monorepo","last_synced_at":"2026-01-25T15:31:25.690Z","repository":{"id":253800281,"uuid":"844443984","full_name":"Anatoly-Semenov/docs-monorepo","owner":"Anatoly-Semenov","description":"Monorepo with document storage services on nest.js with apps: rest-api, grpc-api, worker, kafka-consumer","archived":false,"fork":false,"pushed_at":"2024-08-19T14:28:13.000Z","size":379,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-13T10:36:35.627Z","etag":null,"topics":["cron","docker","grpc","helm-charts","http","ioc","jest","kafka","makefile","minio","monorepo","nest","nodejs","postgresql","redis","redis-bull","s3","typeorm","winston-logger","worker"],"latest_commit_sha":null,"homepage":"https://nestjs.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Anatoly-Semenov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-19T09:16:06.000Z","updated_at":"2024-08-19T14:33:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"672f7760-8f71-4e6f-89e9-d82f16440040","html_url":"https://github.com/Anatoly-Semenov/docs-monorepo","commit_stats":{"total_commits":12,"total_committers":2,"mean_commits":6.0,"dds":0.08333333333333337,"last_synced_commit":"d8e07a2e2c570d6fa9c7b7cefb84ca38dea3b54d"},"previous_names":["anatoly-semenov/docs-monorepo"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anatoly-Semenov%2Fdocs-monorepo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anatoly-Semenov%2Fdocs-monorepo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anatoly-Semenov%2Fdocs-monorepo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Anatoly-Semenov%2Fdocs-monorepo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Anatoly-Semenov","download_url":"https://codeload.github.com/Anatoly-Semenov/docs-monorepo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254484637,"owners_count":22078756,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cron","docker","grpc","helm-charts","http","ioc","jest","kafka","makefile","minio","monorepo","nest","nodejs","postgresql","redis","redis-bull","s3","typeorm","winston-logger","worker"],"created_at":"2024-09-24T13:58:01.428Z","updated_at":"2026-01-25T15:31:25.684Z","avatar_url":"https://github.com/Anatoly-Semenov.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docs-monorepo\n\nСтруктура директорий проекта с описанием:\n\n```text\n.\n├── Makefile                - Файл директив Make\n├── README.md               - Этот документ\n├── .env                    - Файл окружения инфраструктуры проекта \n├── app.env                 - Файл окружения исполнения логики проекта\n├── docker-compose.yaml     - Файл-конфигурация Docker Compose\n├── env.d                   - Директория файлов инфраструктурного обеспечения проекта \n│   ├── charts.d            - Директория Helm-чартов\n│   ├── conf.d              - Директория различных файлов конфигурации\n│   ├── docker.d            - Директория конфигурации Docker и сопутствующих файлов\n│   ├── dotenv.d            - Директория файлов Dotenv\n│   └── mk.d                - Директория фалов-компонент директив Make\n├── nest-cli.json           - Файл конфигурации Nest CLI\n├── node_modules            - Директория пакетов NPM\n├── package.json            - Файл-описание Node-проекта\n├── src                     - Исходный код проекта\n│   ├── bootstrap           - Конфигурирование проекта\n│   ├── common              - Общие модули для доменов (авторизация, конфиг и тп.) \n│   ├── domains             - Домены (в доменах могут быть еще домены)\n│   │   ├── domain_name     - Название домена\n│   │   │   ├── controllers - Контроллеры\n│   │   │   ├── dto         - Data Transfer Object\n│   │   │   │   └──  v1     - Версия интерфейса\n│   │   │   └── services    - Бизнес логика\n│   ├── providers           - Провайдеры модулей\n│   └── shared              - Константы, декораторы, интерфейсы, схемы БД\n├── test                    - Unit и интеграционные тесты\n├── tsconfig.build.json     - Файл-расширение параметров сборки Typescript\n├── tsconfig.json           - Основной файл конфигурации Typescript\n└── yarn.lock               - Файл-журнал версий установленных зависимостей\n\n```\n\n## 1. Подготовка к запуску\n\nОкружение запуска должно быть `*nix`-совместимым\n(т.е. должно обладать терминалом и `*nix`-окружением).\n\nНативными окружениями являются любые Linux-дистрибутивы и macOS.\n\nНа Windows, необходимо установить WSL и работать в окружении WSL.\n\n### 1.1. Dotenv\n\nЛокально, проект конфигурируется двумя файлами \nв нотации Dotenv - инфраструктурным и проектным.\nДля запуска проекта, необходимо скопировать шаблоны \nфайлов в корень проекта, и заполнить значения внутри:\n\n```bash\nmake prepare_project\n```\n\nДалее, необходимо открыть файлы `app.env` и `.env`, и \nвставить полученные значения кредов в пустые значения \n(пустые после знака `=`).\n\n# 2. Сборка\n\nДалее, следует произвести сборку образов проекта:\n\n```bash\nmake build_clean\n```\n\nПо результатам сборки, в консоли не должно быть ни одной красной или\nжелтой строки (т.е. не должно быть ошибок и предупреждений сборки)\n\n# 3. Запуск\n\nПосле сборки, остаётся лишь запустить проект:\n\n```bash\nmake up\n```\n\nПосле выполнения команды, в консоли будут зеленые строки-статус запуска,\nа в интерфейсе Docker for Desktop будут отображаться все контейнеры проекта,\nописанные в `docker-compose.yaml`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanatoly-semenov%2Fdocs-monorepo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanatoly-semenov%2Fdocs-monorepo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanatoly-semenov%2Fdocs-monorepo/lists"}