add README

README.md

@@ -1,3 +1,52 @@
+<h1 align="center">Welcome to PodCastLM 👋</h1>
+
+[中文说明](/README_CN.md)
+
+## ✨ Demo
+[demo.mp4](https://github.com/user-attachments/assets/ed846901-069e-48c5-8576-01b017cd581a)
+
+Try it Online ⚡️:  [PodCastLM](https://endearing-rabanadas-2ee528.netlify.app.)
+
+## OverView
+This project is inspired by the NotebookLM tool, This tool processes the content of a PDF, generates a natural dialogue suitable for an audio podcast, and outputs it as an MP3 file.
+
+## 💻 TechStack
+- [React](https://react.dev/) - FrontEnd Development
+- [Tailwindcss](https://tailwindcss.com/) - CSS Engine
+- [FastAPI](https://fastapi.tiangolo.com/) - BackEnd Development
+
+## 💗  Credit
+- [Llama-3.1-405B](https://huggingface.co/meta-llama/Llama-3.1-405B) - AI Powered
+- [Azure OpenAI TTS](https://azure.microsoft.com/en-us/products/ai-services/openai-service) - TTS Powered
+
+## 👤 Author
+**YOYZHANG**
+
+- Twitter: [@alexu19049062](https://twitter.com/alexuzhang19049062)
+- Github: [@YOYZHANG](https://github.com/YOYZHANG)
+- Wechat: whdxzxq
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome. 😄<br />
+Feel free to check [issues page](https://github.com/YOYZHANG/podcastlm/issues) if you want to contribute.<br />
+
+
+## 📝 License
+MIT License © 2024 YOYZHANG
+
+## Others
+
+Please ⭐️ this repository if this project helped you!
+
+Your appreciation is my greatest strength in updating content！
+
+<a href="https://www.buymeacoffee.com/zhangxiaoqian" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+
+---
+
+
+
 # PodCastLM
 
 ## 功能

README_CN.md

@@ -0,0 +1,45 @@
+<h1 align="center">欢迎来到 PodCastLM 👋</h1>
+
+## ✨ 示例
+[/public/demo.mp4](https://github.com/user-attachments/assets/ed846901-069e-48c5-8576-01b017cd581a)
+
+在线地址: ⚡️ [PodCastLM](https://endearing-rabanadas-2ee528.netlify.app.)
+
+## OverView
+该项目的灵感来自于 Google NotebookLM 工具。通过处理 PDF 的内容，生成适合音频播客的自然对话，并将其输出为 MP3 文件。
+
+
+## 💻 技术栈
+- [React](https://react.dev/) - FrontEnd Development
+- [Tailwindcss](https://tailwindcss.com/) - CSS Engine
+- [FastAPI](https://fastapi.tiangolo.com/) - BackEnd Development
+
+## 💗 AI 模型
+- [Llama-3.1-405B](https://huggingface.co/meta-llama/Llama-3.1-405B) - AI Powered
+- [Azure OpenAI TTS](https://azure.microsoft.com/en-us/products/ai-services/openai-service) - TTS Powered
+
+## 👤作者
+
+如果有任何疑问或技术上的交流，可以在 Twitter 或微信上联系我。
+
+**YOYZHANG**
+
+- twitter: [@alexu19049062](https://twitter.com/alexuzhang19049062)
+- 微信: whdxzxq
+
+## 🤝 贡献
+欢迎贡献 [issues](https://github.com/YOYZHANG/ai-ppt/issues).
+如果这个项目对你有帮助，欢迎 ⭐️ 或 Fork.
+
+
+## 📝 License
+MIT License © 2024 YOYZHANG
+
+## 👀 其他
+你的赞赏是我更新内容最大的功力：
+
+<a href="https://www.buymeacoffee.com/zhangxiaoqian" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+
+
+---
+

backend/README.md

@@ -1,11 +1,37 @@
----
-title: PodcastLM Backend
-emoji: 👀
-colorFrom: gray
-colorTo: green
-sdk: docker
-pinned: false
-license: mit
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+## Installation
+
+To set up the project, follow these steps:
+
+1. **Clone the repository:**
+   ```bash
+   git clone [email protected]:YOYZHANG/PodCastLM.git
+   cd PodCastLM/backend
+   ```
+
+2. **Create a virtual environment and activate it:**
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate
+   ```
+
+3. **Install the required packages:**
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+## Usage
+
+1. **Set up API Key(s):**
+   For this project, I am using LLama 3.1 405B hosted on Fireworks API and Azure OpenAI TTS API. So, please set the API key as the `FIREWORKS_API_KEY` and `SPEECH_KEY`environment variable
+
+```
+FIREWORKS_API_KEY=
+SPEECH_KEY=
+```
+
+2. **Run the application:**
+   ```bash
+   uvicorn main:app --reload
+   ```
+## License
+MIT License © 2024 YOYZHANG

frontend/README.md

@@ -1,50 +1,23 @@
-# React + TypeScript + Vite
+## Installation
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+To set up the project, follow these steps:
 
-Currently, two official plugins are available:
+1. **Clone the repository:**
+   ```bash
+   git clone [email protected]:YOYZHANG/PodCastLM.git
+   cd PodCastLM/frontend
+   ```
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+2. **install dependencies:**
+   ```bash
+   pnpm install
+   ```
 
-## Expanding the ESLint configuration
+## Usage
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-export default tseslint.config({
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
+```sh
+pnpm run dev
 ```
+## License
 
-- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
-- Optionally add `...tseslint.configs.stylisticTypeChecked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
-
-```js
-// eslint.config.js
-import react from 'eslint-plugin-react'
-
-export default tseslint.config({
-  // Set the react version
-  settings: { react: { version: '18.3' } },
-  plugins: {
-    // Add the react plugin
-    react,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended rules
-    ...react.configs.recommended.rules,
-    ...react.configs['jsx-runtime'].rules,
-  },
-})
-```
+MIT License © 2024 YOYZHANG