Onyxia 开源项目教程

Onyxia 开源项目教程

onyxia🔬 Web app to simplify data science environment setup on Kubernetes项目地址:https://gitcode.com/gh_mirrors/on/onyxia

1. 项目目录结构及介绍

Onyxia 项目的目录结构如下：

onyxia/
├── .github/
│   ├── ISSUE_TEMPLATE/
│   └── workflows/
├── api/
│   ├── src/
│   │   ├── main/
│   │   └── test/
│   └── pom.xml
├── catalog/
│   ├── src/
│   │   ├── main/
│   │   └── test/
│   └── pom.xml
├── docs/
│   ├── assets/
│   ├── guides/
│   └── index.md
├── helm-charts/
│   ├── onyxia/
│   └── README.md
├── onyxia-ui/
│   ├── public/
│   ├── src/
│   │   ├── app/
│   │   ├── assets/
│   │   ├── components/
│   │   ├── pages/
│   │   └── styles/
│   ├── package.json
│   └── README.md
├── pom.xml
└── README.md

目录结构介绍

• .github/: 包含 GitHub 相关的配置文件，如 Issue 模板和 CI/CD 工作流。
• api/: 包含 Onyxia 的后端 API 代码，使用 Java 编写。
• catalog/: 包含项目的数据目录相关代码。
• docs/: 包含项目的文档，包括用户指南和资产文件。
• helm-charts/: 包含 Onyxia 的 Helm 配置文件，用于 Kubernetes 部署。
• onyxia-ui/: 包含 Onyxia 的前端代码，使用 React 框架。
• pom.xml: Maven 项目配置文件，用于管理项目的依赖和构建。
• README.md: 项目的主 README 文件，包含项目的概述和基本信息。

2. 项目启动文件介绍

Onyxia 项目的启动文件主要位于 api/ 和 onyxia-ui/ 目录下。

后端启动文件

• api/src/main/java/fr/insee/onyxia/api/OnyxiaApplication.java: 这是 Onyxia 后端的主启动类，负责启动 Spring Boot 应用程序。

前端启动文件

• onyxia-ui/src/index.js: 这是 Onyxia 前端的主入口文件，负责初始化 React 应用程序。
• onyxia-ui/package.json: 包含前端项目的依赖和脚本配置，如 npm start 用于启动开发服务器。

3. 项目配置文件介绍

Onyxia 项目的配置文件主要位于 api/ 和 helm-charts/ 目录下。

后端配置文件

• api/src/main/resources/application.yml: 这是 Spring Boot 应用程序的主要配置文件，包含数据库连接、服务端口等配置。

前端配置文件

• onyxia-ui/.env: 包含前端的环境变量配置，如 API 地址等。

Helm 配置文件

• helm-charts/onyxia/values.yaml: 这是 Helm 部署的主要配置文件，包含 Kubernetes 资源的配置，如服务、部署、存储等。

通过以上介绍，您可以更好地理解 Onyxia 项目的结构和配置，从而更高效地进行开发和部署。

onyxia🔬 Web app to simplify data science environment setup on Kubernetes项目地址:https://gitcode.com/gh_mirrors/on/onyxia