Skip to content

Commit

Permalink
feat: add the workflow to auto update the contributors in README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Suraj-kumar00 committed Oct 21, 2024
1 parent f258722 commit 33fcffa
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 21 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/add-contributors.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Add contributors
on:
push:
branches:
- main

jobs:
add-contributors:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: BobAnkh/add-contributors@master
with:
CONTRIBUTOR: "### Contributors"
COLUMN_PER_ROW: "6"
ACCESS_TOKEN: ${{secrets.PAT_TOKEN}}
IMG_WIDTH: "100"
FONT_SIZE: "14"
PATH: "/README.md"
COMMIT_MESSAGE: "docs(README): update contributors"
AVATAR_SHAPE: "circle"
57 changes: 36 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,99 +14,117 @@
<br>
</div>
<br>


Introducing **FlashFathom AI** – the ultimate flashcard generator. Effortlessly create and study personalized flashcards with AI precision, while enjoying seamless user experiences and secure payments.
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

<div align="center">
<img src="./public/Flash-Fathom-AI-Signin-And-Card.gif" alt="Tutorial to demonstrate signin and generating flash cards" width="1000" ></img>
</div>


## 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)


![](./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
## 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:
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
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.
Expand All @@ -116,34 +134,31 @@ If you encounter any bugs or have feature requests, please follow this format wh
- 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)





## 👀 Our Valuable Contributors 💖✨
### Contributors

Thanks to these wonderful people:
<br/>
<br/>
<a href="https://github.com/Suraj-kumar00/Flash-Fathom-AI/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Suraj-kumar00/Flash-Fathom-AI" />
</a>


<!-- <a href="https://github.com/Suraj-kumar00/Flash-Fathom-AI/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Suraj-kumar00/Flash-Fathom-AI" />
</a> -->

## 📬 Contact

For questions or feedback, feel free to reach out via GitHub issues or contact the project maintainers. ✉️

## License

This project is licensed under the [MIT License!](https://github.com/Suraj-kumar00/Flash-Fathom-AI/blob/main/LICENSE)

## Support via giving a ⭐ star
## Support via giving a ⭐ star

If you like this project, please give it a ⭐ star. Your support means a lot to us!

<h2 align="center"> Happy Coding🚀✨</h2>

0 comments on commit 33fcffa

Please sign in to comment.