https://github.com/rishicds/TLDR

Read less,TL;DR more
https://github.com/rishicds/TLDR

ai daisyui nextjs summarization tailwindcss tldr

Last synced: 3 months ago
JSON representation

Read less,TL;DR more

• Host: GitHub
• URL: https://github.com/rishicds/TLDR
• Owner: rishicds
• License: cc0-1.0
• Created: 2024-07-04T16:11:33.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-25T04:35:51.000Z (6 months ago)
• Last Synced: 2024-07-30T20:54:22.847Z (6 months ago)
• Topics: ai, daisyui, nextjs, summarization, tailwindcss, tldr
• Language: TypeScript
• Homepage: https://tldr-nice.vercel.app
• Size: 2.17 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TL;DR

A mordern and fast Document Summarizer built using NextJS 14, TailwindCSS, NeonDB. Currently supports directly uploads of PDFs and PDF Links

## Demo

https://github.com/rishicds/TLDR/assets/124495375/2b3e94cb-51de-4898-a1dc-d03975ff74d5

## Tech Stack

1. NextJS 14

2. Tailwind CSS

3. NeonDB

4. Pinecone

5. Clerk

6. AWS Storage

## How to Install 

1. Fork and ⭐ the repository

2. Clone the repository using `git clone https://github.com/rishicds/TLDR.git`

3. Install the dependencies using `npm i`.

4. Fill the env as shown:

```

//clerk

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=

CLERK_SECRET_KEY=

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in

NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/

NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/

//neondb

DATABASE_URL=

//AWS

NEXT_PUBLIC_S3_ACCESS_KEY_ID=

NEXT_PUBLIC_S3_SECRET_ACCESS_KEY=

NEXT_PUBLIC_S3_BUCKET_NAME=

//Pinecone

PINECONE_ENVIRONMENT=

PINECONE_API_KEY=

```

5. Run the project using `npm run dev`.

6. run `npx drizzle-kit push` to create schema and push to NeonDB.

* Note: Make sure you allow Public access on AWS S3 Bucket

* Set Bucket policy as :

* ```

    {"Version": "2012-10-17",

    "Statement": [

        {

            "Sid": "PublicReadGetObject",

            "Effect": "Allow",

            "Principal": "*",

            "Action": "s3:GetObject",

            "Resource": "arn:aws:s3:::{bucketName}/*"

        }

    ]}

* Setup CORS to allow your domain