# cognee-demo

**Repository Path**: greycode/cognee-demo

## Basic Information

- **Project Name**: cognee-demo
- **Description**: a simpe cognee demo
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-08
- **Last Updated**: 2025-12-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

该项目是一个前后端分离的开源项目，包含了前端和后端两个主要部分。后端使用 FastAPI 框架提供 RESTful API，前端使用 React 和 Vite 构建用户界面。项目支持文件上传、问题查询等功能，并提供数据重置选项。以下是项目的详细说明：

## 后端功能

- **配置管理**：通过 `backend/config.py` 文件管理 API 服务器的配置。
- **核心功能**：`backend/core.py` 文件提供了初始化 Cognee、添加文档、认知处理、搜索和清除数据等功能。
- **API 接口**：`backend/main.py` 文件定义了 `/config`, `/upload`, `/ask`, 和 `/reset` 接口，分别用于获取配置信息、上传文件、提问和重置数据。
- **依赖管理**：通过 `backend/requirements.txt` 文件管理 Python 依赖。

## 前端功能

- **技术栈**：前端使用 React 和 Vite 构建，利用 React Compiler 提升性能。
- **代码规范**：通过 ESLint 进行代码规范检查。
- **样式管理**：使用 CSS 模块化样式管理，确保组件样式独立不冲突。
- **静态资源**：包含 Vite 和 React 的 SVG 图标等静态资源。

## 使用方法

### 后端启动步骤

1. 安装依赖：
   ```bash
   pip install -r backend/requirements.txt
   ```

2. 启动服务：
   ```bash
   uvicorn backend.main:app --reload
   ```

### 前端启动步骤

1. 安装依赖：
   ```bash
   npm install
   ```

2. 启动开发服务器：
   ```bash
   npm run dev
   ```

## API 文档

- **GET /config**: 获取 API 服务器配置信息。
- **POST /upload**: 上传文件到服务器。
- **POST /ask**: 提问并获取回答。
- **POST /reset**: 重置数据。

## 贡献指南

欢迎贡献代码和提出改进建议。请确保遵循项目代码规范，并在提交前进行充分测试。

## 许可证

该项目遵循 MIT 许可证。详情请查看项目根目录下的 LICENSE 文件。