Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add version update notification #17

Merged
merged 3 commits into from
Aug 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,24 @@ Roles can provide more possibilities for question generation and assessment. You

- Document Content: This component displays the actual uploaded document content, serving as the basis and final answer for the question.

## ♻️ Update the Project

When starting the project, the application checks for updates. If an update is required, the user will be notified. You can follow these steps to update:

1. Export your notes, questions, or configuration items as a backup through the **Export Configuration and Notes** button on the personal settings page.

> This will export a file named `examor-data.xlsx`. You can view the file contents, but it's not recommended to modify the file content.

<img width="700" src="/docs/screen-shot/en-export-import.png" />

2. Pull the latest remote code updates to refresh your local project.

3. Delete the existing Docker container and rebuild the project with the `docker-compose run` command to incorporate the latest changes.

4. Once the build is successful, navigate to the personal settings page, click the **Import File** button, and re-import the backed-up data into the project.

> The current updating process is based on my personal usage. It might not be the best way to update. If you have better update methods, please feel free to provide assistance in the issues section ❤️

</br>

## Contributing
Expand Down
Binary file added docs/screen-shot/en-export-import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screen-shot/zh-export-import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/zh-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,21 @@ docker-compose up
- 上次的记录:记录用户上一次对该问题的回答和检测的内容

- 文档内容:该组件中会展示用户实际上传的文档内容,也就是产生这个问题的依据和最终答案

## ♻️ 更新项目

当在启动项目的时候,应用会判断是否需要更新,如果版本需要进行更新则会提醒用户。您可以通过以下几步进行更新:

1. 将您的笔记、问题或配置项通过个人配置页面中的 **导出配置及笔记** 按钮进行导出作为备份

> 将会导出一个名为 `examor-data.xlsx` 的文件,您可以查看文件内容,但不建议对文件内容进行修改

<img width="700" src="/docs/screen-shot//zh-export-import.png" />

2. 重新拉取更新最新的远程代码,更新本地的项目

3. 删除原有的 docker 容器,使用 `docker-compose run` 命令重新构建最新的项目

4. 构建成功后进入个人配置页面,点击 **文件导入** 按钮,将备份过的数据重新导入到项目中

> 目前的更新方式是我个人的使用方式,这一定不是最好的更新方式。如果您有更好的更新方法,十分欢迎在 issus 中提供帮助 ❤️