Excalidraw协作版项目搭建与使用指南

1. 项目目录结构及介绍

Excalidraw协作版项目的目录结构如下：

excalidraw-collaboration/
├── _assets/              # 存储项目所需的静态资源文件
├── advanced-nginx/       # 高级配置，使用nginx进行请求代理
├── basic/                # 基础配置，包含启动项目的最小配置
├── .gitignore            # 指定git忽略的文件和目录
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
└── docker-compose.yaml   # Docker容器编排文件

• _assets/：存储项目所需的静态资源文件，如图标、图片等。
• advanced-nginx/：高级配置目录，其中包含了使用nginx进行请求代理的配置文件。
• basic/：基础配置目录，包含了启动项目的最小配置，适用于本地开发环境。
• .gitignore：指定在执行git操作时应该忽略的文件和目录，以避免将不必要的文件提交到版本控制。
• LICENSE：项目所使用的许可证文件，本项目采用MIT许可证。
• README.md：项目的说明文件，包含了项目的描述、使用方法等信息。
• docker-compose.yaml：Docker容器编排文件，用于定义和运行多容器Docker应用程序。

2. 项目的启动文件介绍

项目的启动主要通过docker-compose命令来执行，以下是在basic/目录下启动项目的基本步骤：

1. 克隆项目到本地：

   git clone [e-mail]:alswl/excalidraw-collaboration.git
   

2. 切换到项目的基础配置目录：

   cd excalidraw-collaboration/basic
   

3. 使用Docker Compose启动容器：

   docker-compose up
   

4. 启动浏览器并访问本地服务：

   open "http://localhost"
   

启动后，你可以在浏览器中看到Excalidraw的页面，点击“Live Collaboration”按钮即可进入协作模式。

3. 项目的配置文件介绍

项目的配置主要通过docker-compose.yaml文件进行，以下是配置文件的基本内容：

version: '3'
services:
  app:
    image: excalidraw/excalidraw
    ports:
      - "80:80"
      - "443:443"
    environment:
      - VITE_APP_HTTP_STORAGE_BACKEND_URL=http://localhost
      - VITE_APP_WS_SERVER_URL=ws://localhost
    volumes:
      - ./data:/app/data
    networks:
      - excalidraw
  nginx:
    image: nginx:alpine
    ports:
      - "8080:80"
    volumes:
      - ./nginx.conf:/etc/nginx/nginx.conf
    networks:
      - excalidraw
networks:
  excalidraw:

• app：这是Excalidraw服务的主要服务，使用官方镜像excalidraw/excalidraw。

• ports：映射容器的端口到主机。

• environment：设置环境变量，用于配置服务。

• volumes：挂载卷，用于持久化数据。

• networks：定义网络，用于容器间通信。

• nginx：用于代理请求的nginx服务。

• nginx.conf：nginx的配置文件，需要自定义以匹配项目需求。

通过修改docker-compose.yaml文件，可以调整服务配置，如绑定不同的端口、配置存储后端和WebSocket服务器的URL等。在部署到公网时，还需要修改环境变量以使用HTTPS证书和域名。