Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Elliott-Chong/chatpdf-yt
https://github.com/Elliott-Chong/chatpdf-yt
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/Elliott-Chong/chatpdf-yt
- Owner: Elliott-Chong
- Created: 2023-09-04T12:32:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-17T10:34:05.000Z (5 months ago)
- Last Synced: 2024-07-31T08:19:15.218Z (3 months ago)
- Language: TypeScript
- Homepage: https://chatpdf-elliott.vercel.app
- Size: 194 KB
- Stars: 657
- Watchers: 9
- Forks: 271
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - Elliott-Chong/chatpdf-yt - (TypeScript)
README
[Link to YouTube Tutorial](https://www.youtube.com/watch?v=bZFedu-0emE)
# Overview
Welcome to the "chatpdf-yt" project, a comprehensive chat application with PDF integration. This project is designed to provide a seamless chat experience where users can upload PDF files, create chats around them, and interact with an AI assistant. The AI assistant uses the OpenAI API to generate responses based on the chat context. The application also includes a subscription feature, where users can subscribe to access premium features. The subscription process is handled using Stripe for payments and webhooks for event processing.
hi this is a test change!
# Technologies and Frameworks
- Next.js
- React
- TypeScript
- Tailwind CSS
- Clerk
- Drizzle ORM
- PostgreSQL
- AWS SDK
- OpenAI API
- Stripe
- Axios
- Pinecone
- Drizzle-kit
- OpenAI Edge
- Neon Database Serverless
- Drizzle-orm/neon-http
- @tanstack/react-query
- @clerk/nextjs
- clsx
- tailwind-merge
# Installation
Follow the steps below to install and setup the project:
1. **Clone the repository**
Open your terminal and run the following command:
```bash
git clone https://github.com/Elliott-Chong/chatpdf-yt.git
```
2. **Navigate to the project directory**
```bash
cd chatpdf-yt
```
3. **Install Node.js**
The project requires Node.js version 13.4.19 or later. You can download it from [here](https://nodejs.org/en/download/).
4. **Install the required dependencies**
Run the following command to install all the required dependencies:
```bash
npm install
```
This will install all the dependencies listed in the `package.json` file, including Next.js, React, React DOM, Axios, Stripe, Tailwind CSS, and other specific dependencies such as "@aws-sdk/client-s3" and "@clerk/nextjs".
5. **Setup environment variables**
Create a `.env` file in the root directory of your project and add the required environment variables.
6. **Run the project**
Now, you can run the project using the following command:
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.