{"id":21434393,"url":"https://github.com/serguun42/mss","last_synced_at":"2025-07-14T14:31:29.464Z","repository":{"id":39642315,"uuid":"345141752","full_name":"serguun42/mss","owner":"serguun42","description":"MIREA Schedule System: Node.js backend with OpenAPI, Telegram bot with mailing, Vue frontend, and web-scrapper","archived":false,"fork":false,"pushed_at":"2024-06-14T14:30:20.000Z","size":12403,"stargazers_count":16,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-06-14T15:57:44.716Z","etag":null,"topics":["android","kotlin","mongodb","nodejs","openapi","telegraf","telegram","telegram-bot","vue"],"latest_commit_sha":null,"homepage":"https://mirea.xyz","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serguun42.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":"2021-03-06T16:33:26.000Z","updated_at":"2024-06-14T14:30:25.000Z","dependencies_parsed_at":"2023-11-16T00:26:15.648Z","dependency_job_id":"488c24c2-7926-43cd-b49a-d7964b35d871","html_url":"https://github.com/serguun42/mss","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serguun42%2Fmss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serguun42%2Fmss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serguun42%2Fmss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serguun42%2Fmss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serguun42","download_url":"https://codeload.github.com/serguun42/mss/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225980891,"owners_count":17554919,"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":["android","kotlin","mongodb","nodejs","openapi","telegraf","telegram","telegram-bot","vue"],"created_at":"2024-11-22T23:35:36.442Z","updated_at":"2024-11-22T23:35:36.939Z","avatar_url":"https://github.com/serguun42.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MIREA Schedule System\n\n![MSS](https://mirea.xyz/img/logo_wide_transparent.png)\n\n## Complete system for MIREA schedule\n\nThis repo represents all the code, structure and pipelines for MSS project, including\n\n- [Frontend](./frontend) for [mirea.xyz](https://mirea.xyz) site\n- [Backend](./backend) with API for that\n- [Telegram bot](./telegram) available by [@mirea_table_bot](https://t.me/mirea_table_bot)\n- [Scrapper](./scrapper) – script for parsing tables for each study group\n- [Notifier](./notifier) – collecting and sending logs and errors\n- [Android app](./app) – outdated, [see this page](https://mirea.xyz/apps)\n\n## Project's API\n\nMSS has public API with common methods and actions. You can view and test it with [Redoc](https://mirea.xyz/docs/api/redoc.html) or with [Swagger UI](https://mirea.xyz/docs/api/swagger).\n\n## Folders\n\nEach folder contains its own README with. Here's the list of them with responsible dev and main info for each:\n\n| Folder                       |                    Dev                     | What is used and how it works                                                                                                                                                                                                                                                                                                   |\n| ---------------------------- | :----------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [Backend](./backend)         | [@serguun42](https://github.com/serguun42) | Handles back for front, back for API, back for user accounts. All the stuff.                                                                                                                                                                                                                                                    |\n| [Frontend](./frontend)       | [@serguun42](https://github.com/serguun42) | Front done with Vue.js. View and save groups' schedule.                                                                                                                                                                                                                                                                         |\n| [Telegram bot](./telegram)   | [@serguun42](https://github.com/serguun42) | Sends schedule on demand, stores users, does mailing on morning, evening and late evening. Notifies via [notifier](./notifier), uses local Telegram API server (if specified), uses local MongoDB [mirea-table-bot](https://github.com/serguun42/mirea-table-bot) was the base for it.                                          |\n| [Scrapper](./scrapper)       | [@serguun42](https://github.com/serguun42) | Parses schedule page, gets links to `.xlsx`-files, parses them then, builds table models for each and every possible study group, updates DB schedule for each group of those ones.                                                                                                                                             |\n| [Notifier](./notifier)       | [@serguun42](https://github.com/serguun42) | Runs local HTTP server, notifies into _System Telegram_, logs into _stdout_, _stderr_. Use tags (inner and passed), determines which output(s) will be used to log/notify.                                                                                                                                                      |\n| [Panel](./panel)             | [@serguun42](https://github.com/serguun42) | Configuration panel for admins to fine-tune some of the system parameters, such as semester start date and scraping interval. Requires authentication via in-house Keycloak.                                                                                                                                                    |\n| [Monitoring](./monitoring)   | [@serguun42](https://github.com/serguun42) | Monitoring done with Prometheus and Grafana. Comes with pre-built panel for monitoring Backend (see [`backend/backend-server.js`](./backend/backend-server.js#L14) and [`monitoring/grafana/node-dashboard.json`](./monitoring/grafana/node-dashboard.json)). Uses Panel as gateway/reverse-proxy with Keycloak authentication. |\n| [Healthchech](./healthcheck) | [@serguun42](https://github.com/serguun42) | Standalone healthcheck service that deploys to Yandex.Cloud Serverless containers and gives current status of the MSS.                                                                                                                                                                                                          |\n| [Keycloak](./keycloak)       | [@serguun42](https://github.com/serguun42) | In-house instance of Keycloak to authenticate admin users for such parts of MSS as Panel. See [`docker-compose.yml`](./docker-compose.yml) for details.                                                                                                                                                                         |\n| [Android app](./app)         |  [@rodyapal](https://github.com/rodyapal)  | Android app written in Kotlin. Serves the same task as Frontend. _Outdated, [see this page](https://mirea.xyz/apps)_.                                                                                                                                                                                                           |\n\n## CI/CD\n\nBuild \u0026 deploy are now being done with Docker. See workflow files and [docker-compose.yml](./docker-compose.yml). In total there are 3 Github Action workflow scripts:\n\n- [build.yml](.github/workflows/build.yml) contains main workflow for deploying production.\n- [notify-on-merge.yml](.github/workflows/notify-on-merge.yml) serves to notify on event `pull_request` into every branch.\n- [notify-on-push.yml](.github/workflows/notify-on-push.yml) serves to notify on event `push` into every branch except `master`.\n\n---\n\n### Этот проект, всё его содержимое и разработчики не связаны с администрацией РТУ МИРЭА.\n\n### [License](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserguun42%2Fmss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserguun42%2Fmss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserguun42%2Fmss/lists"}