WebDB-App 项目使用教程

WebDB-App 项目使用教程

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

WebDB-App 项目的目录结构如下：

WebDB-App/
├── editorconfig
├── eslintrc.cjs
├── gitignore
├── gitlab-ci.yml
├── CONTRIBUTING.md
├── LICENCE
├── README.md
├── TODO.md
├── local_history.patch
├── updateDeps.sh
├── back
│   ├── compatibility
│   └── github
├── front
│   └── static
└── static

目录结构介绍

• editorconfig: 编辑器配置文件。
• eslintrc.cjs: ESLint 配置文件。
• gitignore: Git 忽略文件配置。
• gitlab-ci.yml: GitLab CI/CD 配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENCE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• TODO.md: 待办事项列表。
• local_history.patch: 本地历史记录补丁文件。
• updateDeps.sh: 更新依赖的脚本文件。
• back: 后端相关代码和配置文件。
  • compatibility: 兼容性相关代码。
  • github: GitHub 相关代码。
• front: 前端相关代码和静态资源。
  • static: 静态资源文件。
• static: 其他静态资源文件。

2. 项目的启动文件介绍

WebDB-App 项目的启动文件主要位于 back 和 front 目录中。具体启动文件如下：

后端启动文件

• back/compatibility/index.js: 后端主入口文件，负责启动后端服务。
• back/github/index.js: GitHub 相关服务的启动文件。

前端启动文件

• front/static/index.html: 前端主入口 HTML 文件。
• front/static/main.js: 前端主入口 JavaScript 文件，负责初始化前端应用。

3. 项目的配置文件介绍

WebDB-App 项目的配置文件主要用于配置项目的运行环境和行为。以下是主要的配置文件：

后端配置文件

• back/config/default.json: 默认配置文件，包含数据库连接、端口等配置。
• back/config/production.json: 生产环境配置文件，覆盖默认配置。
• back/config/development.json: 开发环境配置文件，覆盖默认配置。

前端配置文件

• front/config/env.js: 前端环境配置文件，包含 API 地址、调试模式等配置。
• front/config/routes.js: 前端路由配置文件，定义前端页面的路由规则。

通过以上配置文件，可以灵活地调整 WebDB-App 项目的运行环境和行为，以适应不同的开发和生产需求。