sirius-web 的安装和配置教程

项目基础介绍

Sirius Web 是一个开源的低代码平台，用于定义支持您特定视觉语言的自定义 Web 应用程序。这个项目基于 Eclipse Sirius，将其成功原则应用到现代云基础架构上，使得用户可以更容易地在 Web 上创建和部署工作室。

主要编程语言

该项目主要使用 Java 进行后端开发，前端则采用了 TypeScript 和 React 等技术。

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

• 后端: 使用 Spring Boot 作为应用程序框架，以及 JPA 进行数据持久化。
• 前端: 使用 React 进行界面构建，以及 TypeScript 提供类型安全。
• 数据库: 使用 PostgreSQL 作为关系数据库。
• 其他: 项目还使用了 Docker 来简化部署流程，以及 Maven 和 npm 管理依赖。

项目安装和配置的准备工作

在开始安装之前，请确保您的系统已经安装以下工具和依赖：

1. Java 17: Sirius Web 需要Java 17环境。
2. Apache Maven 3.6.3: 用于构建后端组件。
3. Docker: 用于运行 PostgreSQL 数据库和测试。
4. Node.js 和 npm: LTS 版本，特别是 Node >= 18.7.0 和 npm >= 8.15.0，用于构建前端组件。
5. GitHub Access Token: 用于 Maven 和 npm 访问 GitHub 包。

详细安装步骤

步骤 1: 克隆项目

首先，您需要从 GitHub 上克隆项目到本地环境：

git clone https://github.com/eclipse-sirius/sirius-web.git

步骤 2: 配置 Maven 和 npm

• 配置 Maven: 创建或编辑 $HOME/.m2/settings.xml 文件，添加您的 GitHub 凭据：

  <settings>
    <servers>
      <server>
        <id>github-sirius-emfjson</id>
        <username>$GITHUB_USERNAME</username>
        <password>$GITHUB_ACCESS_TOKEN</password>
      </server>
      <server>
        <id>github-flow</id>
        <username>$GITHUB_USERNAME</username>
        <password>$GITHUB_ACCESS_TOKEN</password>
      </server>
    </servers>
  </settings>
  

  替换 $GITHUB_USERNAME 和 $GITHUB_ACCESS_TOKEN 为您的 GitHub 用户名和个人访问令牌。

• 配置 npm: 创建或编辑 $HOME/.npmrc 文件，添加您的 GitHub 凭据：

  //npm.pkg.github.com/:_authToken=$GITHUB_ACCESS_TOKEN
  

  替换 $GITHUB_ACCESS_TOKEN 为您的个人访问令牌。

步骤 3: 构建前端和后端组件

• 构建前端组件: 进入项目目录，运行以下命令来安装依赖并构建前端组件：

  npm ci
  npx turbo run build
  

  如果需要运行测试，可以使用：

  npx turbo run coverage
  

• 构建后端组件: 使用 Maven 构建后端组件：

  mvn clean install
  

步骤 4: 运行应用程序

• 启动 PostgreSQL: 使用 Docker 启动 PostgreSQL 服务：

  docker run -p 5433:5432 --rm --name sirius-web-postgres \
  -e POSTGRES_USER=dbuser \
  -e POSTGRES_PASSWORD=dbpwd \
  -e POSTGRES_DB=sirius-web-db \
  -d postgres:15
  

  如果您没有 Docker 或想要使用现有的 PostgreSQL 安装，请相应调整命令行参数。

• 启动 Sirius Web 应用程序: 运行以下命令来启动应用程序：

  java -jar sirius-web.jar \
  --spring.datasource.url=jdbc:postgresql://localhost:5433/sirius-web-db \
  --spring.datasource.username=dbuser \
  --spring.datasource.password=dbpwd
  

  如果遇到端口冲突，可以更改 Docker 命令和 Java 启动器中的端口。

• 访问应用程序: 在浏览器中访问 http://localhost:8080，即可使用 Sirius Web。

请确保在测试完成后，停止 PostgreSQL 容器以避免数据丢失：

docker kill sirius-web-postgres