Skip to content

YHIsMyLove/knowledge-network

Repository files navigation

Knowledge Network

Knowledge Network 是一个基于 Vue 和 Vite 构建的现代化 Web 应用,用于管理和展示知识网络。项目采用 TypeScript 和 TailwindCSS,具有模块化设计和清晰的组件结构,旨在提供高效、直观的用户体验。

目录

项目简介

本项目旨在构建一个融合多种功能的知识管理平台,支持以下主要功能:

  • 知识图谱展示与交互:直观展示知识间的联系和层次结构。
  • 日历视图:展示待办事项、日常笔记及事件。
  • Markdown 编辑器:支持笔记的快速编辑与预览。
  • AI 助手集成:提供 AI 模型设置及相关操作,辅助提升用户体验。

特点

  • 模块化设计
    每个功能模块均由独立组件实现,易于维护和扩展。
    例如:KnowledgeGraph.vue 提供了知识图谱展示功能,DailyNotesCalendar.vue 实现了日历组件。

  • 现代化前端技术
    使用 Vue 3 搭配 TypeScript 提供类型安全支持,并借助 Vite 加速开发构建过程。

  • 响应式布局
    利用 TailwindCSS 实现响应式设计,兼容各种设备。

  • 优秀的用户体验
    精心设计的界面和流畅的交互,确保用户在使用过程中的高效和愉悦。

架构与技术栈

  • 前端框架:Vue 3
  • 构建工具:Vite(配置文件:vite.config.ts)
  • 语言:TypeScript
  • 样式:TailwindCSS(配置文件:tailwind.config.js)
  • 单元测试:Vitest(配置文件:vitest.config.ts)

项目结构

  • 根目录

    • index.html —— 应用入口文件
    • package.json —— 项目信息及依赖配置
  • 公共资源
    资源文件存放于 public/ 下,如 favicon.ico

  • 源码目录

    • src/ —— 主要代码目录,包含:
      • App.vue —— 根组件
      • main.ts —— 入口脚本
      • components/ —— 应用各功能组件,如 AI 模型设置、知识图谱、日历组件、Markdown 编辑器、待办列表等
      • stores/ —— 全局状态管理
      • router/ —— 路由配置
      • services/ —— 与后端、AI 接口交互逻辑
      • lib/ —— 工具和辅助函数

安装与运行

  1. 安装依赖

    确保已安装 Node.js,然后在项目根目录运行:

    npm install
  2. 开发环境

    运行开发服务器,开始实时调试:

    npm run dev
  3. 构建生产版本

    执行以下命令构建项目:

    npm run build
  4. 运行测试

    使用 Vitest 运行单元测试:

    npm run test

贡献

欢迎对本项目进行贡献。请确保提交符合以下要求:

  • 遵循项目编码规范和 Prettier 配置。
  • 编写必要的单元测试,确保代码稳定性。
  • 修改文档时,请更新此 README 以反映最新变更。

许可协议

本项目采用 MIT 协议,详细信息请参阅 LICENSE 文件。

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published