{"id":23209797,"url":"https://github.com/suraj-kumar00/flash-fathom-ai","last_synced_at":"2025-08-19T04:32:35.458Z","repository":{"id":252945372,"uuid":"841991909","full_name":"Suraj-kumar00/Flash-Fathom-AI","owner":"Suraj-kumar00","description":"Building FlashFathom AI SAAS project that generate Flascards","archived":false,"fork":false,"pushed_at":"2024-10-29T20:27:02.000Z","size":20443,"stargazers_count":21,"open_issues_count":19,"forks_count":21,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-29T22:47:22.467Z","etag":null,"topics":["cicd","clerk","docker","firebase","flashcard-application","flashfathomai","github-actions","gssoc-ext","gssoc24","hacktoberfest","nextjs","opensource","stripe"],"latest_commit_sha":null,"homepage":"https://flash-fathom-ai.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Suraj-kumar00.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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-08-13T13:02:36.000Z","updated_at":"2024-10-29T20:30:16.000Z","dependencies_parsed_at":"2024-10-25T12:44:36.283Z","dependency_job_id":"d5fbda98-f850-4b78-9763-d89abf6b6fbc","html_url":"https://github.com/Suraj-kumar00/Flash-Fathom-AI","commit_stats":null,"previous_names":["suraj-kumar00/flashcard-saas"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-kumar00%2FFlash-Fathom-AI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-kumar00%2FFlash-Fathom-AI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-kumar00%2FFlash-Fathom-AI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Suraj-kumar00%2FFlash-Fathom-AI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Suraj-kumar00","download_url":"https://codeload.github.com/Suraj-kumar00/Flash-Fathom-AI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230318988,"owners_count":18207886,"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":["cicd","clerk","docker","firebase","flashcard-application","flashfathomai","github-actions","gssoc-ext","gssoc24","hacktoberfest","nextjs","opensource","stripe"],"created_at":"2024-12-18T18:20:19.118Z","updated_at":"2025-08-19T04:32:35.420Z","avatar_url":"https://github.com/Suraj-kumar00.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![flashfathom-ai](./public//Flash-Fathom-AI-Banner.png)\n\n\u003cdiv align=\"center\"\u003e\n  \n\u003c/br\u003e\n    \u003cimg alt=\"GitHub Repo stars\" src=\"https://img.shields.io/github/stars/Suraj-kumar00/Flash-Fathom-AI?logo=github\"\u003e \u003c/img\u003e\n    \u003cimg alt=\"GitHub Repo forks\" src=\"https://img.shields.io/github/forks/Suraj-kumar00/Flash-Fathom-AI?logo=github\"\u003e \u003c/img\u003e\n    \u003cimg alt=\"GitHub License\" src=\"https://img.shields.io/github/license/Suraj-kumar00/Flash-Fathom-AI\"\u003e\u003c/img\u003e\n    \u003cimg alt=\"GitHub Repo issues\" src=\"https://img.shields.io/github/issues/Suraj-kumar00/Flash-Fathom-AI?logo=issues\"\u003e \u003c/img\u003e\n    \u003cimg alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/Suraj-kumar00/Flash-Fathom-AI?logo=github\"\u003e\u003c/img\u003e\n    \u003cimg alt=\"Flash-Fathom-AI Release\" src=\"https://img.shields.io/github/v/release/Suraj-kumar00/Flash-Fathom-AI?sort=semver\"\u003e\u003c/img\n                                                                                                       \n[![Build and Push flashfathom-ai Docker Image to DockerHub](https://github.com/Suraj-kumar00/Flash-Fathom-AI/actions/workflows/build-push-docker.yml/badge.svg?branch=main)](https://github.com/Suraj-kumar00/Flash-Fathom-AI/actions/workflows/build-push-docker.yml)\n\u003c/div\u003e\n\n## About Flash Fathom AI\n\n**Flash Fathom AI** is an intelligent flashcard learning platform that revolutionizes how you study and retain information. Powered by advanced AI technology, it combines personalized content generation, spaced repetition algorithms, and intuitive study modes to maximize your learning efficiency.\n\n### Why Choose Flash Fathom AI?\n\n- **AI-Powered Content Generation**: Instantly create flashcards using Gemini API\n- **Advanced Spaced Repetition**: Scientific learning algorithms that adapt to you\n- **Mobile-First Design**: Study anywhere with responsive UI and gestures\n- **Real-Time Search**: Instantly find cards and decks\n- **Flexible Subscriptions**: Plans for every learner's needs\n\n[Get Started](https://flash-fathom-ai.vercel.app/) • [🤝 Contribute](#quick-start)\n\n## Demo\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"\" alt=\"Tutorial to generate flash cards\" width=\"1000\" \u003e\u003c/img\u003e\n\u003c/div\u003e\n\n## 🛠️ Tech Stack\n\n### Frontend\n- **Next.js 15**\n- **TypeScript**\n- **Tailwind CSS**\n- **shadcn/ui**\n\n### Backend \u0026 Database\n- **Next.js API Routes**\n- **PostgreSQL** (via **Supabase**)\n- **Prisma ORM**\n\n### Authentication \u0026 Payments\n- **Clerk v6**\n- **Razorpay**\n\n### AI \u0026 APIs\n- **OpenAI API**\n- **Gemini API**\n\n### DevOps \u0026 Deployment\n- **Docker**\n- **Vercel**\n- **GitHub Actions**\n\n## Project WorkFlow\n\n![](./public/FlashFathomAI-Architecture.png)\n\n\n## ✨ Features\n\n###  Core Features\n\n- Secure authentication (Clerk)\n- AI-based flashcard generation using Gemini API\n- Study modes with spaced repetition\n- Real-time global search\n\n### Study Experience\n\n- Touch gesture support\n- Difficulty tracking\n- Analytics and progress tracking\n- Fully responsive \u0026 mobile-friendly\n- Offline study mode\n\n### Subscription Management\n\n- Free, Basic (₹59/₹590), Pro (₹99/₹990), Org (₹159/₹1,590)\n- Monthly/Yearly with 2-month discount\n- Razorpay-secured payments\n- Learning stats \u0026 usage analytics\n\n### Advanced Features\n\n- Real-time search with filters\n- Export to PDF or Anki\n- Team/Org collaboration\n- In-depth performance analytics\n\n\n##  Quick Start\n\n### Prerequisites\n\n- Node.js 18+\n- `pnpm`\n- PostgreSQL (or Supabase)\n- Clerk account\n- Razorpay account\n- OpenAI API key\n\n### 1. Clone \u0026 Setup\n\n```bash\ngit clone https://github.com/your-username/Flash-Fathom-AI\ncd Flash-Fathom-AI\nnpm install -g pnpm\npnpm install\n```\n\n### 2. Add Environment Variables\n\nCreate `.env.local` with the .env.example file we have\n\n### 3. Setup Database\n\n```bash\npnpm prisma generate\npnpm prisma db push\n```\n\n### 4. Start Development\n\n```bash\npnpm run dev\n# Visit: http://localhost:3000\n```\n\n---\n\n## 🐳 Docker Deployment\n\n### Quick Run\n\n```bash\ndocker pull surajkumar00/flashfathom-ai\ndocker run -it -p 3000:3000 surajkumar00/flashfathom-ai\n```\n\n### Custom Build\n\n```bash\ndocker build -t flashfathom-ai .\ndocker run -it -p 3000:3000 --env-file .env.local flashfathom-ai\n```\n---\n\n## API Documentation\n\n### Auth\n\n- `GET /api/auth/user` – Get current user\n- `POST /api/auth/webhook` – Handle Clerk webhook\n\n### Payments\n\n- `POST /api/razorpay/create-order`\n- `POST /api/razorpay/verify-payment`\n\n### Study\n\n- `POST /api/study/start`\n- `POST /api/study/record`\n- `POST /api/study/complete`\n\n### Content\n\n- `GET/POST /api/decks`\n- `GET/POST/PUT/DELETE /api/flashcards`\n- `GET /api/search`\n\n---\n\n## Issue Reporting\n\nPlease include:\n- 🔍 **Issue Title**\n- 📝 **Description**\n- 🚶 **Steps to Reproduce**\n- ✅ **Expected vs ❌ Actual Behavior**\n- 🖥️ **Environment Info**\n\n[Open an issue](https://github.com/Suraj-kumar00/Flash-Fathom-AI/issues)\n\n---\n\n## 🤝 Contributing\n\nWe welcome PRs! [**Read the Contribution Guidlines**](https://github.com/Suraj-kumar00/Flash-Fathom-AI/blob/main/CONTRIBUTING.md)\n\n### Steps:\n\n```bash\n# Fork \u0026 clone\ngit checkout -b feature/your-feature\n# Make changes\ngit commit -m \"feat: add your feature\"\ngit push origin feature/your-feature\n# Open a Pull Request\n```\n\n### Standards\n\n- TypeScript\n- ESLint + Prettier \n- Before raising PR locally build should pass all checks\n- Conventional commits\n- Add test coverage\n\n## Contributors\n\n\u003ctable\u003e\n\u003ctr\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/Suraj-kumar00\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/123288511?v=4 width=\"100;\"  alt=Suraj/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eSuraj\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/Shivansh-22866\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/131197200?v=4 width=\"100;\"  alt=Shivansh/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eShivansh\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/milansamuel609\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/75712741?v=4 width=\"100;\"  alt=Milan P Samuel/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eMilan P Samuel\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/zaheer-Khan3260\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/150288870?v=4 width=\"100;\"  alt=Zaheer khan/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eZaheer khan\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/AnushkaChouhan25\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/157525924?v=4 width=\"100;\"  alt=Anushka Chouhan/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eAnushka Chouhan\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/haseebzaki-07\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/147314463?v=4 width=\"100;\"  alt=Haseeb Zaki/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eHaseeb Zaki\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/Sachin2815\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/100368589?v=4 width=\"100;\"  alt=Sachin Singh/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eSachin Singh\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/alok-mishra143\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/100504874?v=4 width=\"100;\"  alt=ALOK MISHRA/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003eALOK MISHRA\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/subhamagarrwal\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/130570909?v=4 width=\"100;\"  alt=subhamagarrwal/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003esubhamagarrwal\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\" style=\"word-wrap: break-word; width: 150.0; height: 150.0\"\u003e\n        \u003ca href=https://github.com/T-Rahul-prabhu-38\u003e\n            \u003cimg src=https://avatars.githubusercontent.com/u/167653990?v=4 width=\"100;\"  alt=t rahul prabhu/\u003e\n            \u003cbr /\u003e\n            \u003csub style=\"font-size:14px\"\u003e\u003cb\u003et rahul prabhu\u003c/b\u003e\u003c/sub\u003e\n        \u003c/a\u003e\n    \u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\u003cbr/\u003e\n\n## License\n\nThis project is licensed under the [MIT License!](https://github.com/Suraj-kumar00/Flash-Fathom-AI/blob/main/LICENSE)\n\n## Support via giving a ⭐ star\n\nIf you like this project, please give it a ⭐ star. Your support means a lot to us!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuraj-kumar00%2Fflash-fathom-ai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuraj-kumar00%2Fflash-fathom-ai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuraj-kumar00%2Fflash-fathom-ai/lists"}