https://github.com/suraj-kumar00/flash-fathom-ai

Building FlashFathom AI SAAS project that generate Flascards
https://github.com/suraj-kumar00/flash-fathom-ai

cicd clerk docker firebase flashcard-application flashfathomai github-actions gssoc-ext gssoc24 hacktoberfest nextjs opensource stripe

Last synced: about 2 months ago
JSON representation

Building FlashFathom AI SAAS project that generate Flascards

Host: GitHub
URL: https://github.com/suraj-kumar00/flash-fathom-ai
Owner: Suraj-kumar00
License: mit
Created: 2024-08-13T13:02:36.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-10-29T20:27:02.000Z (12 months ago)
Last Synced: 2024-10-29T22:47:22.467Z (12 months ago)
Topics: cicd, clerk, docker, firebase, flashcard-application, flashfathomai, github-actions, gssoc-ext, gssoc24, hacktoberfest, nextjs, opensource, stripe
Language: TypeScript
Homepage: https://flash-fathom-ai.vercel.app
Size: 19.5 MB
Stars: 21
Watchers: 1
Forks: 21
Open Issues: 19
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

![flashfathom-ai](./public//Flash-Fathom-AI-Banner.png)

GitHub License

Flash-Fathom-AI Release

## About Flash Fathom AI

**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.

### Why Choose Flash Fathom AI?

- **AI-Powered Content Generation**: Instantly create flashcards using Gemini API
- **Advanced Spaced Repetition**: Scientific learning algorithms that adapt to you
- **Mobile-First Design**: Study anywhere with responsive UI and gestures
- **Real-Time Search**: Instantly find cards and decks
- **Flexible Subscriptions**: Plans for every learner's needs

[Get Started](https://flash-fathom-ai.vercel.app/) • [🤝 Contribute](#quick-start)

## Demo

## 🛠️ Tech Stack

### Frontend
- **Next.js 15**
- **TypeScript**
- **Tailwind CSS**
- **shadcn/ui**

### Backend & Database
- **Next.js API Routes**
- **PostgreSQL** (via **Supabase**)
- **Prisma ORM**

### Authentication & Payments
- **Clerk v6**
- **Razorpay**

### AI & APIs
- **OpenAI API**
- **Gemini API**

### DevOps & Deployment
- **Docker**
- **Vercel**
- **GitHub Actions**

## Project WorkFlow

![](./public/FlashFathomAI-Architecture.png)

## ✨ Features

### Core Features

- Secure authentication (Clerk)
- AI-based flashcard generation using Gemini API
- Study modes with spaced repetition
- Real-time global search

### Study Experience

- Touch gesture support
- Difficulty tracking
- Analytics and progress tracking
- Fully responsive & mobile-friendly
- Offline study mode

### Subscription Management

- Free, Basic (₹59/₹590), Pro (₹99/₹990), Org (₹159/₹1,590)
- Monthly/Yearly with 2-month discount
- Razorpay-secured payments
- Learning stats & usage analytics

### Advanced Features

- Real-time search with filters
- Export to PDF or Anki
- Team/Org collaboration
- In-depth performance analytics

## Quick Start

### Prerequisites

- Node.js 18+
- `pnpm`
- PostgreSQL (or Supabase)
- Clerk account
- Razorpay account
- OpenAI API key

### 1. Clone & Setup

```bash
git clone https://github.com/your-username/Flash-Fathom-AI
cd Flash-Fathom-AI
npm install -g pnpm
pnpm install
```

### 2. Add Environment Variables

Create `.env.local` with the .env.example file we have

### 3. Setup Database

```bash
pnpm prisma generate
pnpm prisma db push
```

### 4. Start Development

```bash
pnpm run dev
# Visit: http://localhost:3000
```

---

## 🐳 Docker Deployment

### Quick Run

```bash
docker pull surajkumar00/flashfathom-ai
docker run -it -p 3000:3000 surajkumar00/flashfathom-ai
```

### Custom Build

```bash
docker build -t flashfathom-ai .
docker run -it -p 3000:3000 --env-file .env.local flashfathom-ai
```
---

## API Documentation

### Auth

- `GET /api/auth/user` – Get current user
- `POST /api/auth/webhook` – Handle Clerk webhook

### Payments

- `POST /api/razorpay/create-order`
- `POST /api/razorpay/verify-payment`

### Study

- `POST /api/study/start`
- `POST /api/study/record`
- `POST /api/study/complete`

### Content

- `GET/POST /api/decks`
- `GET/POST/PUT/DELETE /api/flashcards`
- `GET /api/search`

---

## Issue Reporting

Please include:
- 🔍 **Issue Title**
- 📝 **Description**
- 🚶 **Steps to Reproduce**
- ✅ **Expected vs ❌ Actual Behavior**
- 🖥️ **Environment Info**

[Open an issue](https://github.com/Suraj-kumar00/Flash-Fathom-AI/issues)

---

## 🤝 Contributing

We welcome PRs! [**Read the Contribution Guidlines**](https://github.com/Suraj-kumar00/Flash-Fathom-AI/blob/main/CONTRIBUTING.md)

### Steps:

```bash
# Fork & clone
git checkout -b feature/your-feature
# Make changes
git commit -m "feat: add your feature"
git push origin feature/your-feature
# Open a Pull Request
```

### Standards

- TypeScript
- ESLint + Prettier
- Before raising PR locally build should pass all checks
- Conventional commits
- Add test coverage

## Contributors

_Suraj

_Shivansh

_{Milan P Samuel}

_{Zaheer khan}

_{Anushka Chouhan}

_{Haseeb Zaki}