{"id":18187328,"url":"https://github.com/vsdudakov/up_your_english","last_synced_at":"2026-03-03T08:44:25.988Z","repository":{"id":239512819,"uuid":"798734223","full_name":"vsdudakov/up_your_english","owner":"vsdudakov","description":"LLM-based English Improvement App","archived":false,"fork":false,"pushed_at":"2024-05-13T06:15:16.000Z","size":437,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-01T04:26:23.281Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/vsdudakov.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-05-10T11:03:53.000Z","updated_at":"2024-09-12T09:52:51.000Z","dependencies_parsed_at":"2024-11-03T01:03:29.321Z","dependency_job_id":"7da62e5c-8707-4334-a0a6-11d3f666c609","html_url":"https://github.com/vsdudakov/up_your_english","commit_stats":null,"previous_names":["vsdudakov/up_your_english"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vsdudakov/up_your_english","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsdudakov%2Fup_your_english","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsdudakov%2Fup_your_english/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsdudakov%2Fup_your_english/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsdudakov%2Fup_your_english/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vsdudakov","download_url":"https://codeload.github.com/vsdudakov/up_your_english/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vsdudakov%2Fup_your_english/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30038536,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T06:58:30.252Z","status":"ssl_error","status_checked_at":"2026-03-03T06:58:15.329Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":[],"created_at":"2024-11-03T01:03:23.668Z","updated_at":"2026-03-03T08:44:25.923Z","avatar_url":"https://github.com/vsdudakov.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Up Your English\nEnhance your English proficiency with our comprehensive tool. This application combines the power of modern technologies and artificial intelligence to provide an interactive learning experience.\n\n## Screenshots\n\n![Screenshot](https://github.com/vsdudakov/up_your_english/blob/main/screenshot.png)\n\n\n\n## Quickstart\n - Running the Project with Docker\n - Execute the following command to build and run the project:\n\n```bash\nexport OPENAI_API_KEY=\u003cyour_key\u003e\ndocker compose up --build\n```\n\n - Access the application by navigating to: http://localhost:5137\n\n## Continuous Integration (CI)\n### Overview\nWe utilize GitHub Actions to automate our testing and integration processes.\n\n### Backend\n - Tools: Ruff (black, isort, flake8), Pytest\n - Operations: Automated testing is performed on each push and pull request.\n### Frontend\n - Tools: Biome, ESLint, Jest\n - Operations: Automated testing is performed on each push and pull request.\n\n## Architecture\n### Backend\n - Framework: FastAPI/Python, Redis\n - Structure: MVC architecture (Endpoint -\u003e Service -\u003e Adapters)\n - Features:\n   - REST API and Websockets for asynchronous chat functionalities.\n   - Redis queue with brpop to handle websocket messages.\n   - Session management using cookies.\n - Libraries: Utilizes LangChain and OpenAI for AI-driven operations, streaming responses via websockets to the React client.\n### Frontend\n - Framework: Vite / React, TypeScript\n - UI Components: Ant Design (Antd)\n - Chat: react-chat-components library\n - State Management: React Query, React Use Websocket, Context Providers\n\n## Roadmap\n### Testing:\n - Add unit tests for the backend with Pytest.\n - Incorporate smoke tests for the frontend using Jest.\n - Develop automated tests with Playwright for end-to-end testing.\n### Deployment:\n - Implement Continuous Deployment (CD) with GitHub Actions, enabling deployment via releases or manual triggers.\n### Infrastructure:\n - Decouple adapters and backend API logic into a microservice architecture, potentially utilizing Kafka or RabbitMQ.\n - Implement authentication enhancements using HTTP-only cookies or JWT tokens for mobile.\n - Integrate a database to persist chat history and other relevant data.\n### AI Enhancements:\n - Enhance AI functionalities to support multiple prompts within a single session.\n\n\nThis revised README is designed to provide a clear, professional description of your project, its current capabilities, and future development plans. The sections are organized to guide readers easily from setup instructions to deeper technical details.\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvsdudakov%2Fup_your_english","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvsdudakov%2Fup_your_english","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvsdudakov%2Fup_your_english/lists"}