Suraj-kumar00/Flash-Fathom-AI

Introducing FlashFathom AI – the ultimate flashcard generator. Effortlessly create and study personalized flashcards with AI precision, while enjoying seamless user experiences and secure payments. Get started today, track your learning progress, and join a growing community of satisfied users. Would you be ready to elevate your study game? Sign up now and unlock your learning potential!

Demo

Build with

Next.js
Clerk
Firebase
OpenAI
Stripe.

DevOps Practices

Containerization(Docker)
Automation(CI/CD) using GitHub Actions

Project WorkFlow

Features

Clerk Authentication: Secure, seamless user access.
SaaS UI & Landing Page: Polished, user-friendly design.
AI Flashcards: Instantly generate flashcards with OpenAI.
Firebase CRUD: Easy data management.
Stripe Subscriptions: Simple yearly and monthly payments.

Installation

For Installation on local machine follow bellow steps: First fork the reqpository

git clone https://github.com/your-username/Flash-Fathom-AI/
cd Flash-Fathom-AI

Install the dependencies

The package manager

npm install -g pnpm

Install pnpm pakcage manager

pnpm install

If required for you: Installing clerk

pnpm add @clerk/clerk-sdk @clerk/nextjs

OpenAI

pnpm add openai

Firebase

pnpm add firebase

Stripe

pnpm add @stripe/stripe-js

Shadcn UI

pnpm add @shadcn/ui

Running the project using Docker

First Install Docker Desktop

Pull the image

docker pull surajkumar00/flashfathom-ai

Run the Container

docker run -it -p 3000:3000 surajkumar00/flashfathom-ai

Check localhost localhost:3000

Issue Reporting 🐛✨

If you encounter any bugs or have feature requests, please follow this format when opening an issue:

Issue Title: 📝 A concise and descriptive title.
Description: 🔍 Clear and detailed description of the issue or feature request.
Steps to Reproduce (if applicable): 🚶Detailed steps to reproduce the issue.
Expected Behavior: ✅What you expected to happen.
Actual Behavior: ❌What actually happened.

Development 👨‍💻

Want to contribute? Great! We welcome contributions from the community! Please check our Contributing Guidelines for more details on how you can help improve us. Read the Contribution Guidlines