Skip to content

Commit

Permalink
fix: some file fixes and update.
Browse files Browse the repository at this point in the history
  • Loading branch information
Suraj-kumar00 committed Dec 30, 2024
1 parent 6839e1d commit affbccb
Show file tree
Hide file tree
Showing 10 changed files with 558 additions and 1,273 deletions.
12 changes: 4 additions & 8 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,6 @@ NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/generate
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/

#Firebase secrect keys
NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
NEXT_PUBLIC_FIREBASE_APP_ID=
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=

#Openrouter api key
OPENROUTER_API_KEY="your openrouter api key"

Expand All @@ -28,3 +20,7 @@ STRIPE_SECRET_KEY="your stripe secret key"
# email for sending mails to
EMAIL_USER=
EMAIL_PASS=


DATABASE_URL="postgresql://postgres.ieomcyudnkxnbbzkvynt:[your-password]@aws-0-ap-south-1.pooler.supabase.com:5432/postgres"

53 changes: 24 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing Guidelines 🌍

This documentation contains a set of guidelines to help you during the contribution process.
This documentation contains a set of guidelines to help you during the contribution process.
We are happy to welcome all the contributions from anyone willing to improve/add new projects (doesn't matter which language) to this Repository.

<br>
Expand Down Expand Up @@ -28,31 +28,31 @@ If you're new to Git and GitHub, no worries! Here are some useful resources:
```bash
FLASH-FATHOM-AI/
├── .github/ # GitHub-related configurations such as workflows, issue templates, etc
├── public/ # Contains some images for the public purpose
├── src/ # Contains all the source components of the project
├── .env.example
├── .eslintrc.json
├── .gitignore
├── .env.example
├── .eslintrc.json
├── .gitignore
├── CODE_OF_CONDUCT.md # Some rules for the contributors
├── CONTRIBUTING.md # Instructions about how to contribute
├── Dockerfile
├── Dockerfile
├── LICENSE # Basically a permission to do something
├── README.md # Some basic instructions to follow
├──
├── components.json
├──
├──
├── docker-compose.yml
├──
├──
├── next.config.mjs
├──
├── package.json
Expand All @@ -70,7 +70,8 @@ FLASH-FATHOM-AI/

# Before contributing to the repository, here are a few steps you can follow to understand the project

## Installation
## Installation

For Installation on local machine follow bellow steps:
First [fork the reqpository](https://github.com/Suraj-kumar00/Flash-Fathom-AI/fork)

Expand All @@ -96,7 +97,7 @@ npm install -g pnpm
pnpm install
```

If required for you:
If required for you:

**Installing clerk**

Expand All @@ -110,12 +111,6 @@ pnpm add @clerk/clerk-sdk @clerk/nextjs
pnpm add openai
```

**Firebase**

```bash
pnpm add firebase
```

**Stripe**

```bash
Expand All @@ -137,7 +132,7 @@ First Install [**Docker Desktop**](https://www.docker.com/products/docker-deskto
**Pull the image**

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

**Run the Container**
Expand All @@ -159,17 +154,17 @@ We welcome contributions to enhance the AI Customer Support system! To contribut
**Note:** To assign the issue to yourself type `.take` in the commant on the issue.

1. **Star this repository**
Click on the top right corner marked as **Stars** at last.
Click on the top right corner marked as **Stars** at last.

2. **Fork this repository**
Click on the top right corner marked as **Fork** at second last.
Click on the top right corner marked as **Fork** at second last.

3. **Clone the forked repository**

```bash
git clone https://github.com/<your-github-username>/Flash-Fathom-AI.git
```

4. **Navigate to the project directory**

```bash
Expand Down
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ Introducing **FlashFathom AI** – the ultimate flashcard generator. Effortlessl

- Next.js
- Clerk
- Firebase
- OpenAI
- Stripe.

Expand All @@ -49,7 +48,6 @@ Introducing **FlashFathom AI** – the ultimate flashcard generator. Effortlessl
- **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
Expand Down Expand Up @@ -89,12 +87,6 @@ pnpm add @clerk/clerk-sdk @clerk/nextjs
pnpm add openai
```

**Firebase**

```bash
pnpm add firebase
```

**Stripe**

```bash
Expand Down
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
"@clerk/clerk-react": "^5.4.1",
"@clerk/nextjs": "^5.7.5",
"@clerk/themes": "^2.1.20",
"@firebase/firestore": "^4.7.0",
"@hookform/resolvers": "^3.9.0",
"@kinde-oss/kinde-auth-nextjs": "^2.3.6",
"@prisma/client": "^5.22.0",
"@radix-ui/react-dialog": "^1.1.1",
"@radix-ui/react-dropdown-menu": "^2.1.1",
"@radix-ui/react-label": "^2.1.0",
Expand All @@ -23,15 +23,16 @@
"@radix-ui/react-tooltip": "^1.1.2",
"@shadcn/ui": "^0.0.4",
"@stripe/stripe-js": "^4.8.0",
"@supabase/supabase-js": "^2.46.1",
"@tailwindcss/typography": "^0.5.14",
"@types/nodemailer": "^6.4.16",
"@types/react-toastify": "^4.1.0",
"axios": "^1.7.4",
"button": "^1.1.1",
"class-variance-authority": "^0.7.0",
"clsx": "^2.1.1",
"dotenv": "^16.4.5",
"dropdown-menu": "^0.1.1",
"firebase": "^10.14.1",
"framer-motion": "^11.11.11",
"label": "^0.2.2",
"lucide-react": "^0.428.0",
Expand All @@ -57,6 +58,7 @@
"eslint": "^8.57.0",
"eslint-config-next": "14.2.5",
"postcss": "^8.4.41",
"prisma": "^5.22.0",
"tailwindcss": "^3.4.10",
"typescript": "^5.5.4"
}
Expand Down
Loading

0 comments on commit affbccb

Please sign in to comment.