{"id":27874598,"url":"https://github.com/alibekn6/flashcards-master","last_synced_at":"2026-05-03T22:33:34.790Z","repository":{"id":289732465,"uuid":"972019938","full_name":"alibekn6/flashcards-master","owner":"alibekn6","description":"A flashcard study app organized by topics. Users answer questions, flip cards, and track their progress as they learn, for nfactorial 2025","archived":false,"fork":false,"pushed_at":"2025-05-05T18:43:17.000Z","size":365,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-06T10:35:21.156Z","etag":null,"topics":["jwt-authentication","nestjs-backend","postgresql","react"],"latest_commit_sha":null,"homepage":"https://flashcards-master.vercel.app","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/alibekn6.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":"2025-04-24T12:16:00.000Z","updated_at":"2025-05-05T18:43:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"b68f34e2-cf42-4090-b68f-e8aa39d96fae","html_url":"https://github.com/alibekn6/flashcards-master","commit_stats":null,"previous_names":["alibekn6/flashcards-master"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/alibekn6/flashcards-master","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alibekn6%2Fflashcards-master","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alibekn6%2Fflashcards-master/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alibekn6%2Fflashcards-master/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alibekn6%2Fflashcards-master/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alibekn6","download_url":"https://codeload.github.com/alibekn6/flashcards-master/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alibekn6%2Fflashcards-master/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32587819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T22:12:39.696Z","status":"ssl_error","status_checked_at":"2026-05-03T22:09:10.534Z","response_time":103,"last_error":"SSL_read: 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":["jwt-authentication","nestjs-backend","postgresql","react"],"created_at":"2025-05-05T01:36:37.175Z","updated_at":"2026-05-03T22:33:34.771Z","avatar_url":"https://github.com/alibekn6.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flashcards Master – core api / client\n\nЭто серверная и клиентская часть проекта **Flashcards Master** – приложения для интерактивного обучения с использованием карточек. Сервис позволяет пользователям регистрироваться, входить в систему, создавать карточки, отслеживать прогресс и использовать внешние источники, для автоматической генерации карточек.\n\n- ⚠️ Fixed (костыль) запустил питон скрипт который keeps server awake, теперь не придется ждать по минутам 🥳\n\n- **⚠️WARNING⚠️** – ! я использовал бесплатные возможности render и gemini, возможно скорость приложение будет чуть низким (be patient or text me)\n[t.me/internalpointer](https://t.me/internalpointer)\n\n\n## Стек\n\ncore-api\n- **NestJS** – фреймворк Node.js для серверной части\n- **TypeORM** – ORM для PostgreSQL\n- **PostgreSQL** – основная база данных\n- **JWT (JSON Web Token)** – авторизация и аутентификация\n- **Swagger (OpenAPI)** – документация API\n- **Gemini** – Google Gemini для генерации карточек\n- **Jest** – модульное тестирование\n- **ESLint + Prettier + Husky + lint-staged** – обеспечение качества кода\n\n\nclient\n- **React** – фреймворк клиентской части\n- **React router dom** – для удобной навигаций\n- **tailwindcss** - для стилей\n\n---\n\n## 🛠 Установка и запуск сервера\n\n```bash\n\n**server side**\n# 1. Клонировать репозиторий\ngit clone https://github.com/alibekn6/flashcards-master\ncd flashcards-api\n\n# 2. Установить зависимости\nnpm install\n\n# 3. Создать .env файл\n.env\n# отредактируйте .env и укажите свои значения (DB_USER, DB_PASSWORD, JWT_SECRET, GEMINI_API_KEY and so on)\n\n# 4. Запустить PostgreSQL\npgadmin / psql на юникс системах через терминал\n- psql -U {username} -d\n- CREATE DATABASE flashcards, \\q\n- psql -U {username} -d flashcards\nили сделать тоже самое на графическом интерфейсе\n\n# 5. Запустить сервер\nnpm run start:dev\n\n\n\n**client side**\n# 1. перейти в \ncd flashcards-client\n\n# 2. Установить зависимости\nnpm install\n\n# 3. Создать .env файл\n.env\n# отредактируйте .env и укажите свои значения\n\n# 4. указать правильный путь к API\nVITE_API_URL=http://localhost:3000/api\n\n# 5. Запустить сервер\nnpm run dev\n\nвуаля у вас есть локоальная версия моего проекта, enjoy\n\n# auth login (if you dont want to create account and want to see already created fodlers and flashcards)\nemail: alibek@kbtu.kz\npassword: pass\n\n```\n\n\n**Описание процесса проектирования и разработки**\n\n*Архитектура бэкенда (Nest, Postgres)*\n\n- Выбрал модульную структуру с разделением на контроллеры, сервисы и репозитории, что упростило масштабирование и поддержку.\n- Безопасность реализована через JWT-аутентификацию и защищённые маршруты.\n- Для работы с базой данных использовался TypeORM, позволяющий легко управлять миграциями и связями между сущностями.\n- Валидация запросов через Validation Pipes\n\n*Frontend*\n\n- Использованы функциональные компоненты с хуками.\n- Реализация роутинга через React Router.\n- Контекстное хранилище (Context API) используется для управления состоянием.\n- Созданы кастомные хуки для взаимодействия с API.\n- Применены css module для изоляции стилей и обеспечения адаптивности\n\n\n\n\n**Уникальные подходы и методологии**\n\n*Модульность и чистая архитектура:*\n\n- Жесткое разграничение логики между слоями: контроллеры, сервисы, репозитории\n- Это обеспечивает высокую тестируемость и простоту добавления новых фич\n\n*Интеграция искусственного интеллекта (Google Gemini):*\n\n- Генерация карточек осуществляется автоматически на основе заранее продуманных промптов\n\n- Это снижает порог входа для пользователей и ускоряет наполнение контента\n\n*Система тестирования*\n\n- Различные форматы вопросов\n\n- Подсчет правильных/неправильных ответов\n\n\n\n**Компромиссы в процессе разработки**\n\n*Структура базы данных:*\n\n- Связи между карточками и папками реализованы упрощённо\n\n- Это снижает гибкость, но ускоряет разработку на раннем этапе\n\n*Интеграция ИИ*\n- API Gemini вызывается напрямую, без очередей или фоновых задач.\n\n- Это упрощает реализацию, но может привести к проблемам при росте нагрузки.\n\n\n\n**Известные проблемы**\n\n*Генерация карточек:*\n\n- Требуется ручное обновление страницы для отображения новых карточек.\n- Временное решение — ре-рендер.\n\n*Адаптивность:*\n\n- Некоторые элементы не идеально масштабируются на мобильных устройствах.\n\n\n*Режим тестирования:*\n\n- Простейший подсчет очков то есть только на клиенте \n\n- Отсутствует сохранение прогресса между сессиями\n\n\n**почему выбрал этот технический стэк**\n\n*core api*\n- NestJS выбран за модульность, строгую типизацию (TypeScript), легкость масштабировать, добалять и переиспользовать сервисы\n\n- PostgreSQL — надёжная, производительная СУБД\n\n- TypeORM упрощает работу с базой, миграции и взаимодействие с сущностями\n\n\n- это отличный баланс между производительностью и поддерживаемостью\n- Идеально подходит для архитектуры среднего масштаба\n- Прост в расширении и внедрении новых фич\n\n*client*\n\n- React обеспечивает быструю разработку и переиспользуемость компонентов\n\n- React Router упрощает навигацию\n\n- Context API достаточен на текущем этапе, без необходимости внедрения сложного хранилища\n\n- CSS Modules позволяют делать интерфейс адаптивным и поддерживаемым\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falibekn6%2Fflashcards-master","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falibekn6%2Fflashcards-master","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falibekn6%2Fflashcards-master/lists"}