https://github.com/ibttf/recappd-ai

Convert your favorite news articles into a custom-length podcast.
https://github.com/ibttf/recappd-ai

convex googlecloudplatform openai-api

Last synced: about 1 month ago
JSON representation

Convert your favorite news articles into a custom-length podcast.

• Host: GitHub
• URL: https://github.com/ibttf/recappd-ai
• Owner: ibttf
• Created: 2023-10-28T08:02:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-02T04:30:43.000Z (over 1 year ago)
• Last Synced: 2024-04-28T01:10:18.675Z (9 months ago)
• Topics: convex, googlecloudplatform, openai-api
• Language: TypeScript
• Homepage: https://recappd.live
• Size: 3.53 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Recappd AI

### General

This project was built in 48 hours in a team of three as part of CalHacks 10.0.

Deployed on: [Recappd](https://recappd.live)

View Demo: [Demo](https://youtu.be/WWvKcsBsNW0)

If the live doesn't work, then it very likely means we ran out of free credits for one of our various APIs. Let us know with a message or check out how it works in development by following the instructions below:

### Features

- Authenticate using Clerk with Google or Github accounts.

- Select your news category (finance, tech, politics, etc.).

- Customize the podcast duration and frequency.

- Recappd aggregates news using dynamic REST API endpoints.

- Utilizes LLMs for content accuracy.

- Generates an MP3 audio file stored in the Convex database.

- Asynchronous updates using cron workers via Convex.

- Full CRUD capabilities with Convex.

- Technology Stack

- Frontend: NextJS 13 with Typescript, TailwindCSS, shadCN, and HeadlessUI.

- Authentication: Clerk (also integrated with Convex).

- Backend: Convex for real-time data, file storage, and asynchronous cron tasks.

- Speech-to-text: Google Cloud Platform.

- AI: OpenAI's GPT 3.5 model.

- News Retrieval: Newsdata's public API.

- Deployment: Vercel

- Recappd is a monorepo deployed at recapd.live.

### Development Setup

To set up the project for development:

### Clone the repository.

Create a .env file in the project root.

Add the following environment variables to the .env file:

``` .env

NEXT_PUBLIC_NEWS_API_KEY=

NEXT_PUBLIC_OPENAI_API_KEY=

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in

NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/dashboard

NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/dashboard

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=

CLERK_SECRET_KEY=

GCP_PROJECT_ID=

GCP_KEY_FILE_NAME=

FREE_CONVERT_API_KEY=

```

Replace , , , , and  with your actual values.

You can copy and paste this into your README.md file. Make sure to replace the placeholder values with your actual keys when setting up the project.