Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 21 days 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 (5 months ago)
Default Branch: main
Last Pushed: 2024-10-29T20:27:02.000Z (2 months ago)
Last Synced: 2024-10-29T22:47:22.467Z (2 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

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**](https://flash-fathom-ai.vercel.app/), 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

![](./public/Flash-Fathom-AI-WorkFlow.png)

## 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](https://github.com/Suraj-kumar00/Flash-Fathom-AI/fork)

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

## Install the dependencies

**The package manager**

```sh
npm install -g pnpm
```

**Install pnpm pakcage manager**

```sh
pnpm install
```

If required for you:
**Installing clerk**

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

**OpenAI**

```bash
pnpm add openai
```

**Firebase**

```bash
pnpm add firebase
```

**Stripe**

```bash
pnpm add @stripe/stripe-js
```

**Shadcn UI**

```bash
pnpm add @shadcn/ui
```

## Running the project using Docker

First Install [**Docker Desktop**](https://www.docker.com/products/docker-desktop/)

**Pull the image**

```bash
docker pull surajkumar00/flashfathom-ai
```

**Run the Container**

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

**Check localhost**
[localhost:3000](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**](https://github.com/Suraj-kumar00/Flash-Fathom-AI/blob/main/CONTRIBUTING.md)

## Contributors

_Suraj

_Shivansh

_{Milan P Samuel}

_{Zaheer khan}

_{Anushka Chouhan}

_{Haseeb Zaki}