Scholarsome 开源项目教程
项目介绍
Scholarsome 是一个基于 Web 的交互式闪卡学习软件,旨在为那些不想自己托管服务的个人提供免费的学习工具。该项目受到其他开始对核心功能收费的大型网站的启发,旨在成为任何学习工作流的替代品。Scholarsome 是一个开源项目,使用 AGPL-3.0 许可证,支持用户创建自己的学习集,使用 LaTeX 创建数学表达式,分享学习集,导入和导出 Anki、Quizlet 和 CSV 文件,以及多种学习模式。
项目快速启动
安装依赖
首先,确保你已经安装了 Node.js 和 Docker。然后克隆项目仓库:
git clone https://github.com/hwgilbert16/scholarsome.git
cd scholarsome
构建和运行
使用 Docker 构建和运行项目:
docker build -t scholarsome .
docker run -p 3000:3000 scholarsome
现在,你可以在浏览器中访问 http://localhost:3000
来查看运行中的 Scholarsome。
应用案例和最佳实践
创建学习集
用户可以创建自己的学习集,使用 LaTeX 创建数学表达式,并分享给其他用户。以下是一个创建学习集的示例:
- 登录 Scholarsome。
- 点击“创建新集”。
- 输入集的名称和描述。
- 添加闪卡,使用 LaTeX 输入数学表达式。
- 保存并分享学习集。
导入和导出数据
Scholarsome 支持从 Anki、Quizlet 和 CSV 文件导入数据,也支持将数据导出为这些格式。以下是一个导入 CSV 文件的示例:
- 登录 Scholarsome。
- 选择一个现有的学习集或创建一个新的。
- 点击“导入”。
- 选择 CSV 文件并上传。
- 确认导入的数据。
典型生态项目
NestJS
Scholarsome 的后端使用 NestJS 框架,这是一个用于构建高效、可靠和可扩展的服务器端应用程序的框架。
Angular
前端使用 Angular 框架,这是一个用于构建动态 Web 应用程序的平台。
Prisma
Prisma 是一个现代的数据库工具,用于简化数据库访问和操作。
Nx
Nx 是一个用于构建可扩展、高性能的 Angular 应用程序的工具集。
通过这些技术和工具,Scholarsome 提供了一个强大的学习平台,支持用户创建、分享和管理学习内容。