{"id":28614386,"url":"https://github.com/tvfk/parallel-reading","last_synced_at":"2026-04-07T09:32:03.007Z","repository":{"id":290263512,"uuid":"854283724","full_name":"TVFK/parallel-reading","owner":"TVFK","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-10T19:54:33.000Z","size":212,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-10T23:40:48.499Z","etag":null,"topics":["docker","docker-compose","java","kafka","keycloak","minio","nginx","oauth2","opennlp","postgresql","redis","spring","spring-boot","stanford-nlp"],"latest_commit_sha":null,"homepage":"","language":"Java","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/TVFK.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-09-08T21:21:04.000Z","updated_at":"2025-09-10T19:54:37.000Z","dependencies_parsed_at":"2025-04-27T22:27:58.607Z","dependency_job_id":"249935fa-8374-44c2-99e8-91f2bf35fe03","html_url":"https://github.com/TVFK/parallel-reading","commit_stats":null,"previous_names":["tvfk/parallel-reading"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TVFK/parallel-reading","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TVFK%2Fparallel-reading","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TVFK%2Fparallel-reading/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TVFK%2Fparallel-reading/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TVFK%2Fparallel-reading/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TVFK","download_url":"https://codeload.github.com/TVFK/parallel-reading/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TVFK%2Fparallel-reading/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31508011,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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","docker-compose","java","kafka","keycloak","minio","nginx","oauth2","opennlp","postgresql","redis","spring","spring-boot","stanford-nlp"],"created_at":"2025-06-12T01:14:07.027Z","updated_at":"2026-04-07T09:32:02.989Z","avatar_url":"https://github.com/TVFK.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![en](https://img.shields.io/badge/lang-en-red.svg)](README.md)\n[![ru](https://img.shields.io/badge/lang-ru-green.svg)](README.ru.md)\n# Parallel Reading\n\nA platform for parallel reading of books in foreign languages with an integrated dictionary and flashcard system\n\n## Table of Contents\n- [Architecture](#architecture)\n    - [Services](#services)\n    - [Infrastructure](#infrastructure)\n    - [Spring profiles](#spring-profiles)\n- [Quick Start using Docker Compose](#quick-start-using-docker-compose)\n- [Prod deployment](#prod-deployment)\n\n## Architecture\n\n![Architecture scheme](./docs/architectural_scheme_v3.png)\n\n### Services\n\nThe system consists of the following microservices:\n\n1) **Book Service** - manages books, chapters, and pages\n2) **Translation Service** - translates words via the  [Yandex Dictionary API](https://yandex.ru/dev/dictionary/). Using [StanfordNLP](https://nlp.stanford.edu/) for lemmatization\n3) **Dictionary Service** - manages user flashcards and vocabulary, implements the SuperMemo 2 algorithm for interval repetition\n4) **Book Upload Service** - parses book texts using [Apache OpenNLP](https://opennlp.apache.org/)\n5) **Auth Service** - user registration, password reset, etc\n6) **Admin Client** - web interface for administrators\n\n**Frontend app** (Vue.js 3, Typescript, Vite, TailWind): https://github.com/TVFK/parallel-reading-frontend\n\n### Infrastructure\n\n1) **PostgreSQL** - main data storage\n2) **Redis** - caching frequently requested data\n3) **Kafka** - asynchronous communication\n4) **MinIO** - stores book covers and texts\n5) **Keycloak** - OAuth 2.0/OIDC authentication\n6) **Nginx** - reverse proxy and static content distribution\n7) **Victoria Metrics** - collection of metrics\n8) **Grafana Loki** - log collection\n9) **Grafana Tempo** - collecting traces\n10) **Grafana** - visualization of metrics, logs and traces\n\n### Spring profiles\n\n1) **standalone** - for local Spring services startup without Docker\n2) **docker** - local startup of all services without HTTPS, nginx, monitoring etc.\n3) **prod** - for production deployment\n\n## Quick Start using Docker Compose\n\nThe entire application can be run locally using the compose.yaml file, all services will be deployed on localhost\n\n1. **Clone the repository**\n\n```shell\ngit clone https://github.com/TVFK/parallel-reading.git\n```\n\n2. **project collection**\n\n```shell\nmvn clean package -DskipTests\n```\n\n3. **Start all services**\n\n```shell\ndocker compose up -d --build\n```\nThe application will be available at: http://localhost\n\nadmin console: http://localhost:8083\n\nMinIO console: http://localhost:9090\n\nKeycloak console: http://localhost:8082\n\n### Environment variables\n\nTranslation service requires:\n```env\nYANDEX_DICT_API_KEY=your_yandex_dictionary_key\n```\nAPI key for Yandex Dictionary can be obtained at https://yandex.ru/dev/dictionary/\n\n## Prod deployment\n\n1. **Clone the repository**\n\n```shell\ngit clone https://github.com/TVFK/parallel-reading.git\n```\n\n2. **Creating Environment variables**\n\nIn the root of the project next to **compose.prod.yaml** it is necessary to create a **.env** file with these variables:\n\n```text\nBASE_URL=\nDOMAIN=\n\n# Keycloak variables\nKEYCLOAK_DB_PASSWORD=\nKEYCLOAK_ADMIN_LOGIN=\nKEYCLOAK_ADMIN_PASSWORD=\n\n# Minio variables\nMINIO_ROOT_USER=\nMINIO_ROOT_PASSWORD=\n\n# Services db\nBOOKS_DB_PASSWORD=\nDICTIONARY_DB_PASSWORD=\n\n# Services cache\nBOOKS_SERVICE_CACHE_PASSWORD=\nTRANSLATION_SERVICE_CACHE_PASSWORD=\n\nGRAFANA_ADMIN_PASSWORD=\n\nYANDEX_DICT_API_KEY=\n```\n\n3. **Building Spring Services**\n\n```shell\nmvn clean package -DskipTests\n```\n\n4. **Configuring nginx**\n\nIn the **config/nginx/prod/nginx-prod.conf** file, you need to change the domain to your own\n\n5. **Obtaining a TLS certificate**\n\nTo work with **HTTPS** you need to get certificates. You can do this using [certbot](https://certbot.eff.org /)\n\n6. **Starting compose.prod.yaml**\n\n```shell\ndocker-compose -f compose.prod.yaml up -d --build\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftvfk%2Fparallel-reading","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftvfk%2Fparallel-reading","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftvfk%2Fparallel-reading/lists"}