SelfStudyKit

基于 MDUI 的纯前端自习辅助工具集.

每次main分支的提交将自动部署于此: https://SelfStudyKit.fbik.top

特点

• Material Design 界面设计, 简洁且自适应大小屏幕.
• 基于 HTML5, 通过跨平台的浏览器使用.
• 可以直接在本地离线打开, 也可以部署到网页服务器在线使用.
• 为了增强离线的便携性, 有桌面版, 而且文件大小不大.

Feature

勾选内容为已完成的内容

Core

• 一言
• 时钟
• 番茄钟
• 单词本
• 设置

Plus

• gzipped, 使加载速度增快
• Support PWA
• Use ServiceWorker API
• 番茄钟多项预设置支持
• 模块化重构
• Refactoring with TypeScript

Desktop version

• Use Niva
• Use mini-electron
• Use Electron (.asar only)

使用

SelfStudyKit 是纯前端应用, 你可以直接使用浏览器打开构建好的index.html, 在本地启动一个 Web Server, 或者部署到服务器.

每次main分支的提交将自动部署于此: https://SelfStudyKit.fbik.top

如果你有离线使用的需求, 可以前往 Releases 下载 Desktop version 或已经构建好的dist打包, 或者使用源代码自己进行生产模式构建.

Developement

准备

本项目使用pnpm进行包管理, 请确保安装好了pnpm.

npm install -g pnpm

拉取代码&安装依赖

git clone https://github.com/FBIKdot/SelfStudyKit.git
cd SelfStudyKit
pnpm install --no-optional # 不安装可选依赖 (Webpack相关)

开发

开发模式

pnpm dev

生产模式构建

构建后的内容将会输出到/dist目录下, 可以直接使用浏览器打开/dist/index.html离线使用, 或者将/dist目录下的文件部署到网页服务器在线使用.

pnpm build
pnpm preview

使用webpack进行开发与打包

目前没成功通过配置 vite 解决打包出的文件无法被mini-electron打开的问题. 为了打包出的网页支持mini-electron, 在更换打包工具为vite后保留了webpack配置

要想使用 webpack 进行开发与打包, 需要安装可选依赖:

pnpm install

相关scripts请查看package.json.

进行桌面版本开发

待补充

License

SelfStudy 遵循 GPL-3.0 协议.