From 741af85d866f9cb6cf6f56035f2ea87d4f4eb2df Mon Sep 17 00:00:00 2001 From: yyc12345 Date: Tue, 21 Jul 2026 20:40:43 +0800 Subject: [PATCH] doc: update README and ROADMAP --- README.md | 13 ++++++++++--- ROADMAP.md | 16 ++++++++-------- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e497ac7..84a9a4d 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,16 @@ A self-host, multi-account calendar system. ## Warning -This project still work in progress. Because this project need a massive refactor now. -If you want to check out the first version which can fufill basic usage, please switch to `v1-maintain` branch. In `main` branch, I am refactoring v1 and it will be updated to v2 in future. -The first version of this project have too much C-style JavaScript. It is too complicated to maintain and cannot add any other new features. Therefore, it needs to be fully refactored using ES6 and some modern JavaScript tools. It will come soon. +This project is **NOT** suit for any cases in production environment. +It is just a toybox where I learn modern frontend and backend. + +## Version Infos + +If you want to check out the first version which can fufill basic usage, please switch to `v1-maintain` branch. +It is fully written in Python Flask backend and jQuery frontend. + +In `master` branch, I am developing with Go backend and Vue frontend. +And I also learn them from it. ## Features & shortcomings diff --git a/ROADMAP.md b/ROADMAP.md index 5b73ff2..7e018c0 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,10 +1,10 @@ # Roadmap -1. 前后端分离,将前端静态文件和后端Python分装到两个文件夹中。同时辅助类文件夹改换位置。 -1. 后端使用Astral UV重构,使得项目可以跑起来。 -1. 定为1.1版本。1.0版本也要打tag然后提交。然后分叉v1-maintain分支。后续在master上开发v2。 -1. 后端数据库字段重命名。 -1. 前后端通信API命名格式修改。 -1. 使用Vue重写前端 -1. 使用Tailwind重写前端CSS -1. 使用Go重写后端。 +- [x] 前后端分离,将前端静态文件和后端Python分装到两个文件夹中。同时辅助类文件夹改换位置。 +- [x] 后端使用Astral UV重构,使得项目可以跑起来。 +- [x] 定为1.1版本。1.0版本也要打tag然后提交。然后分叉v1-maintain分支。后续在master上开发v2。 +- [x] 后端数据库字段重命名。 +- [ ] 前后端通信API命名格式修改。 +- [x] 使用Vue重写前端 +- [ ] 使用Tailwind重写前端CSS +- [x] 使用Go重写后端。