eCourse项目安装与配置指南

eCourse项目安装与配置指南

eCourse A minimal & customizable template for self-hosting your online course. 项目地址: https://gitcode.com/gh_mirrors/ec/eCourse

1. 项目基础介绍

eCourse 是一个自托管单页应用程序（SPA），旨在简化课程创建和管理过程。它允许用户创建基于视频和文本的内容，分配课程给用户，并跟踪用户的学习进度。eCourse 是开源的，并使用 MIT 许可证发布。

主要编程语言：JavaScript

2. 项目使用的关键技术和框架

• UI 框架：Svelte
• CSS：TailwindCSS
• 图标库：Iconify
• 后端：PocketBase
• 托管服务：PocketHost

3. 项目安装和配置准备工作

在开始安装 eCourse 之前，请确保您的系统中已安装以下工具：

• Node.js（建议版本 12+）
• npm（Node.js 包管理器）
• PocketBase（可以从 PocketBase 官网 下载）

详细的安装步骤

步骤 1：克隆或下载项目

首先，您需要克隆或下载 eCourse 项目到本地环境。打开命令行工具，并执行以下命令：

git clone https://github.com/Ilyas-Codes/eCourse.git

或者，如果您不想使用 git，可以直接从 GitHub 上下载项目的 zip 文件。

步骤 2：设置 PocketBase

1. 将 PocketBase 可执行文件下载到您的操作系统，并放置在项目根目录下的 pb 文件夹中。
2. 在 pb 文件夹内，运行以下命令来启动 PocketBase 服务器：

cd pb
./pocketbase serve

步骤 3：安装前端依赖并启动开发服务器

1. 切换到 ui 文件夹。
2. 安装 Node.js 依赖项：

npm install

3. 运行开发服务器：

npm run dev

此时，您应该能在浏览器中访问 http://localhost:3000 并查看 eCourse 的界面。

步骤 4：自定义配置

如果您需要更改应用程序名称、徽标或颜色，可以通过编辑 customize.json 文件来实现。

步骤 5：构建生产版本

当您准备将应用程序部署到生产环境时，请执行以下步骤：

1. 在 .env 文件中，设置 VITE_PROD_PB_URL 为您的 PocketBase 实例的 URL。
2. 在 ui 文件夹内，构建生产就绪的包：

npm run build

3. 将 dist 文件夹的内容复制到 pb_public 文件夹中。

步骤 6：使用 Docker 部署

eCourse 项目提供了一个 Dockerfile，可以帮助自动化构建和部署过程。以下是如何使用它的基本步骤：

# 使用 Dockerfile 构建镜像
docker build -t ecourse .

# 运行 Docker 容器
docker run -p 8090:8090 ecourse

请确保按照 Dockerfile 中的说明进行适当的配置。

以上步骤为您提供了从零开始安装和配置 eCourse 的详细指南。如果您遇到任何问题或需要进一步的帮助，请查阅项目的官方文档或打开一个 issue。

eCourse A minimal & customizable template for self-hosting your online course. 项目地址: https://gitcode.com/gh_mirrors/ec/eCourse