Skip to content

titxue/ancient-poem

Repository files navigation

Ancient Poem (古诗词网)

一个优雅的古诗词展示网站,用于学习和欣赏中国传统诗词文化。

功能特性

  • 古诗词列表展示
  • 古诗词详情页
  • 收藏功能
    • 收藏/取消收藏
    • 收藏列表页面
    • 本地存储收藏数
    • 收藏数据同步
  • 暗色主题
    • 主题切换按钮
    • 主题配置持久化
    • 响应系统主题
  • 响应式设计
    • 移动端适配
    • 平板适配
    • 桌面端适配
  • 搜索功能优化
    • 搜索建议
    • 搜索历史
    • 高级搜索
  • 性能优化
    • 路由懒加载
    • 图片懒加载
    • 数据缓存
  • 用户体验改进
    • 加载动画
    • 错误处理
    • 操作反馈
  • 其他功能
    • 分享功能
    • 打印功能
    • 导出功能

开发计划

  1. 第一阶段:基础功能

    • 项目初始化
    • 基础架构搭建
    • 古诗词列表页
    • 古诗词详情页
    • 收藏功能
  2. 第二阶段:用户体验

    • 暗色主题支持
    • 响应式设计
    • 搜索功能优化
    • 性能优化
  3. 第三阶段:功能扩展

    • 用户系统
    • 评论功能
    • 分享功能
    • 数据同步 一个优雅的古诗词展示网站,使用 React + TypeScript + Vite 构建。

功能特点

  • 🎯 展示古诗词列表,支持分页浏览
  • 🔍 搜索功能,支持按标题、作者、朝代等搜索
  • ❤️ 收藏功能,支持收藏喜欢的诗词
  • 📝 详细的诗词信息,包括译文、赏析、注释和创作背景
  • 🎨 优雅的界面设计,响应式布局
  • 🚀 快速的加载速度和流畅的用户体验

技术栈

  • React 18
  • TypeScript
  • Redux Toolkit
  • React Router
  • Ant Design
  • SCSS Modules
  • Vite

贡献指南

欢迎贡献代码,提交 Issue 或 Pull Request。详细信息请参考 CONTRIBUTING.md

开源协议

MIT License - 详见 LICENSE 文件。

  • TypeScript 5
  • Vite 4
  • Redux Toolkit
  • React Router 6
  • Ant Design 5
  • Axios
  • SCSS Modules

开发指南

环境要求

  • Node.js >= 16
  • npm >= 8

安装依赖

npm install

开发环境运行

npm run dev

构建生产版本

npm run build

代码检查

npm run lint

项目结构

src/
  ├── components/     # 可复用组件
  ├── pages/         # 页面组件
  ├── services/      # API 服务
  ├── store/         # Redux store
  ├── styles/        # 全局样式
  ├── types/         # TypeScript 类型定义
  └── utils/         # 工具函数

贡献指南

  1. Fork 本仓库
  2. 创建你的特性分支 (git checkout -b feature/amazing-feature)
  3. 提交你的改动 (git commit -m 'feat: add some amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 创建一个 Pull Request

开源协议

本项目使用 MIT 协议。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published