{"id":26745582,"url":"https://github.com/code-418-dpr/kntista-api","last_synced_at":"2026-04-16T08:31:03.812Z","repository":{"id":271638589,"uuid":"913999998","full_name":"code-418-dpr/KNTista-api","owner":"code-418-dpr","description":"Бэкенд для проекта KNTista","archived":false,"fork":false,"pushed_at":"2025-03-25T15:29:05.000Z","size":1144,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T16:32:46.190Z","etag":null,"topics":["backend","docker","drizzle-orm","fastify","kntista","nestjs","rest-api","swagger"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/code-418-dpr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2025-01-08T18:52:19.000Z","updated_at":"2025-03-25T15:28:16.000Z","dependencies_parsed_at":"2025-02-01T21:22:44.855Z","dependency_job_id":"20dbaab3-bc90-4cc2-846c-0a6d0c0e40c2","html_url":"https://github.com/code-418-dpr/KNTista-api","commit_stats":null,"previous_names":["scorpi-on/kntista-api","code-418-dpr/kntista-api"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-418-dpr%2FKNTista-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-418-dpr%2FKNTista-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-418-dpr%2FKNTista-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-418-dpr%2FKNTista-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code-418-dpr","download_url":"https://codeload.github.com/code-418-dpr/KNTista-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245991546,"owners_count":20706129,"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":["backend","docker","drizzle-orm","fastify","kntista","nestjs","rest-api","swagger"],"created_at":"2025-03-28T08:17:49.165Z","updated_at":"2025-03-28T08:17:49.587Z","avatar_url":"https://github.com/code-418-dpr.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KNTista-api\n\n[![license](https://img.shields.io/github/license/Scorpi-ON/KNTista-api)](https://opensource.org/licenses/MIT)\n[![release](https://img.shields.io/github/v/release/Scorpi-ON/KNTista-api?include_prereleases)](https://github.com/Scorpi-ON/KNTista-api/releases)\n[![downloads](https://img.shields.io/github/downloads/Scorpi-ON/KNTista-api/total)](https://github.com/Scorpi-ON/KNTista-api/releases)\n[![code size](https://img.shields.io/github/languages/code-size/Scorpi-ON/KNTista-api.svg)](https://github.com/Scorpi-ON/KNTista-api)\n\n[![linters](https://github.com/Scorpi-ON/KNTista-api/actions/workflows/linters.yaml/badge.svg)](https://github.com/Scorpi-ON/KNTista-api/actions/workflows/linter.yaml)\n[![codeql](https://github.com/Scorpi-ON/KNTista-api/actions/workflows/codeql.yaml/badge.svg)](https://github.com/Scorpi-ON/KNTista-api/actions/workflows/codeql.yaml)\n[![build](https://github.com/Scorpi-ON/KNTista-api/actions/workflows/build.yaml/badge.svg)](https://github.com/Scorpi-ON/KNTista-api/actions/workflows/build.yaml)\n\nБэкенд для проекта KNTista\n\n## Особенности реализации\n\n- отслеживание активности на факультете:\n    - [x] возможность заполнить справочники БД данными\n    - [x] CRUD-операции со всеми сущностями\n    - [x] создание DOCX-отчётов об активности\n    - [ ] параметризованный поиск по всем таблицам с пагинацией\n- [x] документация Swagger\n- [x] интеграция CI/CD\n- [ ] авторизация JWT и OAuth\n- [ ] логирование\n- [ ] кеширование ответов сервера\n- [ ] покрытие тестами\n\n## Стек\n\n- **Node.js** — платформа для запуска JavaScript\n- **SWC** — веб-сборщик (более быстрый, чем стандартный Babel)\n- **pnpm** — пакетный менеджер\n- **TypeScript** — язык программирования\n- **NestJS** — основной бэкенд-фреймворк\n- **Fastify** — фреймворк под капотом NestJS (более быстрый, чем стандартный Express)\n- **Drizzle** — ORM\n- **Jest** — фреймворк для тестирования\n- **Swagger** — инструмент документирования API\n- **ESLint** — статический анализатор кода\n- **Prettier** — форматировщик кода\n- **Docker** — платформа для контейнеризации\n\n## Установка и запуск\n\n0. Клонируйте репозиторий и перейдите в его папку.\n1. Создайте файл `.env` на основе [.env.template](.env.template) и настройте все описанные там сервисы.\n\nВ частности сервер PostrgeSQL можно поднять как вручную, так и через Docker compose командой\n\n```shell\ndocker-compose up -d\n```\n\n2. Заполнить справочные таблицы данными можно командой:\n\n\u003e [!WARNING]\n\u003e Эта команда очистит все данные справочных таблиц перед их заполнением!\n\n```shell\npnpm db:seed\n```\n\nОстальные данные можно внести в графическом режиме, открыв Drizzle Studio:\n\n```shell\npnpm db:studio\n```\n\n### Посредством Docker\n\n3. Установите Docker.\n4. Запустите сборку образа:\n\n```shell\ndocker build -t kntista-api .\n```\n\n5. Теперь запускать образ можно командой:\n\n```shell\ndocker run -d --name kntista-api-standalone -p 3000:3000 kntista-api\n```\n\n### Без использования Docker\n\n3. Установите Node.js и пакетный менеджер pnpm.\n4. Установите зависимости:\n\n```shell\npnpm i\n```\n\n5. Соберите проект:\n\n```shell\npnpm build\n```\n\n6. Теперь запускать проект можно командой:\n\n```shell\npnpm start:prod\n```\n\n## Модификация\n\nЗапуск сервера в режиме отладки осуществляется командой:\n\n```shell\npnpm start:debug\n```\n\nДокументация API в Swagger UI, где его можно будет протестировать, при запуске на локалхосте со стандартными параметрами\nдоступна по ссылке https://localhost:3000/docs.\n\nПрочие скрипты, необходимые для запуска линтера, форматировщика, тестов и т. д. находятся в\nфайле [package.json](./package.json).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-418-dpr%2Fkntista-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-418-dpr%2Fkntista-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-418-dpr%2Fkntista-api/lists"}