geli 开源项目教程

geli 开源项目教程

geli geli is an open source e-learning platform 项目地址: https://gitcode.com/gh_mirrors/ge/geli

1. 项目的目录结构及介绍

geli 项目的目录结构如下：

geli/
├── api/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   └── ...
├── app/
│   └── webFrontend/
│       ├── src/
│       ├── assets/
│       └── ...
├── docs/
│   ├── configuration/
│   ├── development/
│   └── ...
├── docker/
├── github/
├── travis/
├── var/
├── .editorconfig
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── UPGRADE.md
├── Vagrantfile
├── docker-compose.prod.yml
├── docker-compose.yml
├── tslint.json
└── ...

目录结构介绍

• api/: 包含 API 相关的文件，如控制器、模型和路由。
• app/webFrontend/: 包含 Web 前端相关的文件，如源代码、静态资源等。
• docs/: 包含项目的文档，如配置文档、开发文档等。
• docker/: 包含 Docker 相关的配置文件。
• github/: 包含 GitHub 相关的配置文件。
• travis/: 包含 Travis CI 相关的配置文件。
• var/: 包含项目运行时生成的文件。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目介绍文档。
• UPGRADE.md: 项目升级指南。
• Vagrantfile: Vagrant 配置文件。
• docker-compose.prod.yml: 生产环境的 Docker Compose 配置文件。
• docker-compose.yml: 开发环境的 Docker Compose 配置文件。
• tslint.json: TypeScript 代码风格检查配置文件。

2. 项目的启动文件介绍

启动文件

• api/index.js: API 的入口文件，负责启动 Node.js 服务器。
• app/webFrontend/src/main.ts: Web 前端的入口文件，负责启动 Angular 应用。

启动步骤

1. 启动 API:

   • 进入 api/ 目录。
   • 运行 npm run start 启动 API 服务器。

2. 启动 Web 前端:

   • 进入 app/webFrontend/ 目录。
   • 运行 npm run start 启动 Angular 开发服务器。

3. 项目的配置文件介绍

配置文件

• docker-compose.yml: Docker Compose 配置文件，用于本地开发环境的启动。
• docker-compose.prod.yml: Docker Compose 配置文件，用于生产环境的启动。
• tslint.json: TypeScript 代码风格检查配置文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置，指定哪些文件不需要被 Git 管理。
• .travis.yml: Travis CI 配置文件，用于持续集成。

配置文件介绍

• docker-compose.yml: 配置了本地开发环境的 Docker 服务，包括 API 和 Web 前端的容器配置。
• docker-compose.prod.yml: 配置了生产环境的 Docker 服务，通常包含更多的安全性和性能优化。
• tslint.json: 配置了 TypeScript 代码的检查规则，确保代码风格一致。
• .editorconfig: 配置了编辑器的代码风格，确保团队成员使用统一的代码格式。
• .gitignore: 配置了不需要被 Git 管理的文件和目录，避免将不必要的文件提交到版本库。
• .travis.yml: 配置了 Travis CI 的构建和测试流程，确保每次提交的代码都能通过自动化测试。

geli geli is an open source e-learning platform 项目地址: https://gitcode.com/gh_mirrors/ge/geli