{"id":26343805,"url":"https://github.com/w1z2z/students-grades-api","last_synced_at":"2026-05-05T02:40:21.628Z","repository":{"id":222847668,"uuid":"758349637","full_name":"w1z2z/students-grades-api","owner":"w1z2z","description":"This application represents a system for managing students and their grades using Nest.js, Prisma, Postgres, NATS, and Swagger. It subscribes to notifications about new student grades via NATS and saves the data in a database. It includes HTTP endpoints for retrieving a log of grades and student success statistics.","archived":false,"fork":false,"pushed_at":"2024-02-27T13:51:55.000Z","size":95,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-18T10:53:14.149Z","etag":null,"topics":["docker","nats","nestjs","postgresql","prisma","rest-api"],"latest_commit_sha":null,"homepage":"","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/w1z2z.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,"zenodo":null}},"created_at":"2024-02-16T05:54:03.000Z","updated_at":"2024-08-11T13:08:23.000Z","dependencies_parsed_at":"2025-06-18T10:49:07.155Z","dependency_job_id":null,"html_url":"https://github.com/w1z2z/students-grades-api","commit_stats":null,"previous_names":["w1z2z/students-grades-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/w1z2z/students-grades-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w1z2z%2Fstudents-grades-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w1z2z%2Fstudents-grades-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w1z2z%2Fstudents-grades-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w1z2z%2Fstudents-grades-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/w1z2z","download_url":"https://codeload.github.com/w1z2z/students-grades-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/w1z2z%2Fstudents-grades-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268554909,"owners_count":24269062,"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","status":"online","status_checked_at":"2025-08-03T02:00:12.545Z","response_time":2577,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docker","nats","nestjs","postgresql","prisma","rest-api"],"created_at":"2025-03-16T05:18:37.097Z","updated_at":"2026-05-05T02:40:21.600Z","avatar_url":"https://github.com/w1z2z.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Students and Grades Management System\n\nСтэк проекта: Nest.js, Prisma, Postgres, NATS, Swagger\n\n## Алгоритм работы приложения\n\n1. **Подключение к сервису NATS**: Приложение устанавливает соединение с сервером NATS, используя предоставленный IP-адрес и порт. В случае успешного подключения, приложение подписывается на топик `NatsTopicsEnum.STUDENT_GRADES_UPDATED`, чтобы получать уведомления о новых оценках студентов.\n\n2. **Обработка уведомлений о новых оценках**:\n   - При получении уведомления о новой оценке, приложение распаковывает данные и извлекает информацию о студенте, предмете и оценке.\n   - Затем приложение отправляет запрос к сервису студентов через NATS для получения дополнительной информации о студенте.\n   - Полученные данные сохраняются в базу данных с помощью сервиса `StudentsGradesService`.\n\n3. **HTTP-эндпоинты**:\n   - `/log`: Предоставляет лог оценок, отсортированный по дате. Поддерживает пагинацию через query-параметры.\n   - `/statistic/:personalCode`: Возвращает статистику успехов студента по всем предметам.\n\n4. **Интерфейс NATS-топиков**:\n   - `NatsTopicsEnum.STUDENT_GRADES_UPDATED` (subscribe): Уведомление о новой оценке студента.\n   - `NatsTopicsEnum.GET_STUDENT_INFO` (request): Запрос на получение дополнительной информации о студенте.\n\n\n## Установка и запуск\n\n1. Создать файл .env и внести в него следующие данные (пример)\n```yaml\nPORT=8080\n\nDATABASE_URL=\"postgresql://\u003cuser\u003e:\u003cpassword\u003e@postgres:5432/students_grades\"\nNATS_URL=nats://\u003cadress\u003e:\u003cport\u003e\n\nPOSTGRES_USER=\u003cuser\u003e\nPOSTGRES_PASSWORD=\u003cpassword\u003e\nPOSTGRES_DB=students_grades\n```\n2. Запустить докер контейнеры\n```bash\ndocker-compose up --build\n```\n3. Докуменация swagger доступна по адресу [http://localhost:8080/](http://localhost:8080/)\n\n## Пример использования:\n\n### 1) Запрос на получение журнала оценок (логов)\n\n```http\nGET http://localhost:8080/api/log?page=1\u0026limit=10\n```\n\nПример ответа:\n```json\n[\n  {\n    \"date\": \"2024-02-16T14:39:45.215Z\",\n    \"subject\": \"music\",\n    \"grade\": 4,\n    \"student\": {\n      \"personalCode\": \"0425AB018373\",\n      \"name\": \"Jackie\",\n      \"lastName\": \"Thompson\"\n    }\n  },\n  {\n    \"date\": \"2024-02-16T14:40:00.220Z\",\n    \"subject\": \"geography\",\n    \"grade\": 4,\n    \"student\": {\n      \"personalCode\": \"9201CE420779\",\n      \"name\": \"Aaren\",\n      \"lastName\": \"Elliott\"\n    }\n  },\n  {\n    \"date\": \"2024-02-16T14:40:15.252Z\",\n    \"subject\": \"science\",\n    \"grade\": 4,\n    \"student\": {\n      \"personalCode\": \"9201CE420779\",\n      \"name\": \"Aaren\",\n      \"lastName\": \"Elliott\"\n    }\n  }\n]\n```\n\n### 2) Запрос на получение статистики студента по id\n\n```http\nGET http://localhost:8080/api/statistic/:personalCode\n```\n\nПример ответа:\n```json\n{\n  \"student\": {\n    \"personalCode\": \"9201CE420779\",\n    \"name\": \"Aaren\",\n    \"lastName\": \"Elliott\"\n  },\n  \"statistic\": [\n    {\n      \"subject\": \"geography\",\n      \"maxGrade\": 4,\n      \"minGrade\": 4,\n      \"avgGrade\": 4,\n      \"totalGrades\": 1\n    },\n    {\n      \"subject\": \"science\",\n      \"maxGrade\": 4,\n      \"minGrade\": 4,\n      \"avgGrade\": 4,\n      \"totalGrades\": 1\n    }\n  ]\n}\n```\n\n## В целях улучшения кода можно выполнить следующие этапы:\n\n1. **Улучшение производительности**:\n    - Оптимизация запросов к базе данных для сокращения времени ответа.\n    - Внедрение кэширования данных для ускорения доступа к часто используемой информации.\n\n2. **Расширение функциональности**:\n    - Добавление возможности фильтрации и сортировки данных в API для повышения удобства использования.\n    - Введение аутентификации и авторизации для обеспечения безопасности данных и API.\n\n3. **Расширение тестового покрытия**:\n    - Написание дополнительных юнит-тестов для поддержания стабильности функционала.\n    - Реализация тестов интеграции для проверки взаимодействия различных компонентов приложения.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fw1z2z%2Fstudents-grades-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fw1z2z%2Fstudents-grades-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fw1z2z%2Fstudents-grades-api/lists"}