https://github.com/zigaowang/zhidao-frontend
MoonShot 48 Hackathon Runner-up Project | 知道 (ZhiDao) - AI-powered research assistant with personalized subscriptions, and citations. | 知道 - 具有个性化订阅、引用管理和双语支持的人工智能研究助手。
https://github.com/zigaowang/zhidao-frontend
Last synced: 6 months ago
JSON representation
MoonShot 48 Hackathon Runner-up Project | 知道 (ZhiDao) - AI-powered research assistant with personalized subscriptions, and citations. | 知道 - 具有个性化订阅、引用管理和双语支持的人工智能研究助手。
- Host: GitHub
- URL: https://github.com/zigaowang/zhidao-frontend
- Owner: ZigaoWang
- License: mit
- Created: 2025-03-08T01:12:56.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-08T01:52:42.000Z (7 months ago)
- Last Synced: 2025-03-08T02:23:59.251Z (7 months ago)
- Language: HTML
- Homepage:
- Size: 506 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 知道 (ZhiDao) Frontend - AI Research Assistant 🔍
[](https://github.com/ZigaoWang/zhidao-frontend)
[](https://github.com/ZigaoWang/zhidao-frontend)
[](https://github.com/ZigaoWang/zhidao-frontend)
[](LICENSE)
## 📱 Application Screenshots
## 🏆 Key Features
### 🔎 Research Engine (Core Feature)
ZhiDao's primary feature is its powerful research engine that helps users find, analyze, and understand academic research through natural language interactions:
- **Natural Language Queries**: Ask research questions in plain language
- **Academic Paper Search**: Searches multiple academic databases simultaneously
- **AI-Powered Analysis**: Analyzes and synthesizes information from multiple sources
- **Citation Management**: Automatically tracks and displays sources for all information
- **Bilingual Support**: Full support for both English and Chinese languages
### 📰 Research Subscriptions (Bonus Feature)
As a complementary feature, ZhiDao offers personalized research subscriptions:
- **Topic Subscriptions**: Subscribe to research topics of interest
- **Daily Digests**: Receive daily updates on new research in your field
- **Personalized Recommendations**: Get paper recommendations based on your interests
## 🏆 MoonShot 48 Runner-Up
This project was developed during MoonShot 48 hackathon and received **2nd place** in the competition! ZhiDao is an AI-powered research assistant that helps users find, analyze, and understand academic research through natural language interactions.
> **Note**: This is the frontend repository for ZhiDao. The backend repository containing the proprietary algorithms is private and currently being maintained by [Zigao Wang](https://github.com/ZigaoWang).
## 🚀 API Endpoints
This frontend communicates with the backend API through the following endpoints:
GET /question - Process a research question
Process a question through the research pipeline.
**Query Parameters:**
- `query` (string): The user question to be processed
**Response:**
- `200 OK`: Returns the result object with the answer and metadata
- `400 Bad Request`: Missing query parameter
- `500 Internal Server Error`: Error processing the request
GET /stream-question - Process a question with streaming
Process a question with streaming updates.
**Query Parameters:**
- `query` (string): The user question to be processed
**Response:**
- `200 OK`: Returns streaming updates and the final result object with the answer and metadata
- `400 Bad Request`: Missing query parameter
- `500 Internal Server Error`: Error processing the request
GET /stream-daily-digest - Get personalized research updates
Get personalized daily research digests based on subscribed topics.
**Query Parameters:**
- `topics` (string): The topics to receive research updates about
**Response:**
- `200 OK`: Returns the personalized research digest
- `400 Bad Request`: Missing topics parameter
- `500 Internal Server Error`: Error generating the digest
GET /api/daily-article - Get daily article
Get a daily article based on topics.
**Query Parameters:**
- `topics` (string): The topics to receive articles about
- `userId` (string, optional): User identifier for personalization
**Response:**
- `200 OK`: Returns the article
- `400 Bad Request`: Missing topics parameter
- `500 Internal Server Error`: Error retrieving the article
## ⚙️ Setup
### Prerequisites
- Node.js (v14 or higher)
- npm (v6 or higher)
### Installation
1. Clone this repository
```
git clone https://github.com/ZigaoWang/zhidao-frontend.git
cd zhidao-frontend
```
2. Install dependencies
```
npm install
```
3. Configure environment variables
- Copy the `.env.example` file to `.env`
- Update the `BACKEND_API_URL` to point to your backend server
4. Start the server
```
npm start
```
5. Open your browser and navigate to `http://localhost:3001`
## 🧰 Development
- The frontend server is implemented in `server.js`
- Static HTML/CSS/JS files are in the `public` directory
- The server proxies API requests to the backend
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.