Ourboard 项目教程

Ourboard 项目教程

ourboard An online whiteboard 项目地址: https://gitcode.com/gh_mirrors/ou/ourboard

1. 项目目录结构及介绍

Ourboard 是一个在线白板项目，其目录结构如下：

ourboard/
├── .github/
├── backend/             # 后端代码目录
├── benchmark/           # 性能测试代码目录
├── common/              # 公共代码目录
├── frontend/            # 前端代码目录
├── integration/         # 集成测试代码目录
├── keycloak/            # Keycloak 身份验证相关代码
├── perf-tester/         # 性能测试工具目录
├── playwright/          # Playwright 测试相关代码
├── scripts/             # 脚本目录
├── .dockerignore
├── .editorconfig
├── .gitignore
├── .huskyrc.js
├── .nvmrc
├── .prettierignore
├── .prettierrc.js
├── Dockerfile           # Docker 构建文件
├── LICENSE.txt          # 许可证文件
├── README.md            # 项目说明文件
├── cypress.json
├── docker-compose.yaml  # Docker 编排文件
├── lint-staged.config.js
├── package.json         # 项目配置文件
├── playwright.config.ts
├── state-management.md
├── tsconfig.json        # TypeScript 配置文件
├── vitest.config.ts
└── yarn.lock

• backend/: 包含后端代码，使用 TypeScript 编写。
• frontend/: 包含前端代码，同样使用 TypeScript 编写，使用 Harmaja 前端库。
• common/: 包含前后端共用的代码。
• integration/: 包含集成测试代码。
• scripts/: 包含项目构建和辅助脚本。

2. 项目的启动文件介绍

项目的启动主要是通过前端和后端的入口文件实现的：

• 后端启动: 通常在 backend/ 目录下有一个入口文件，例如 index.ts，该文件负责初始化后端服务，如数据库连接、路由设置等。
• 前端启动: 前端启动通常是通过 frontend/ 目录下的 index.tsx 或 main.tsx 文件，该文件负责启动前端应用，通常需要使用 Webpack 或类似的打包工具。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几种：

• package.json: 项目的主要配置文件，定义了项目的名称、版本、依赖、脚本等。
• tsconfig.json: TypeScript 配置文件，定义了 TypeScript 编译器的选项。
• Dockerfile: Docker 构建文件，用于定义如何从项目构建 Docker 镜像。
• docker-compose.yaml: Docker 编排文件，用于定义如何在 Docker 容器中启动项目，包括前端、后端服务以及数据库等。
• .editorconfig: 编辑器配置文件，用于设置代码风格规范。

这些配置文件是项目运行和开发不可或缺的部分，需要根据项目具体需求进行配置和调整。

ourboard An online whiteboard 项目地址: https://gitcode.com/gh_mirrors/ou/ourboard