Backstage 软件模板项目教程

Backstage 软件模板项目教程

software-templatesBackstage Software Templates for creating a new software component项目地址:https://gitcode.com/gh_mirrors/so/software-templates

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

Backstage 软件模板项目的目录结构如下：

software-templates/
├── README.md
├── package.json
├── tsconfig.json
├── lerna.json
├── backstage.json
├── templates/
│   ├── template1/
│   │   ├── template.yaml
│   │   ├── template.json
│   │   ├── README.md
│   │   └── ...
│   ├── template2/
│   │   ├── template.yaml
│   │   ├── template.json
│   │   ├── README.md
│   │   └── ...
│   └── ...
├── plugins/
│   ├── plugin1/
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── index.ts
│   │   │   └── ...
│   │   └── ...
│   ├── plugin2/
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── index.ts
│   │   │   └── ...
│   │   └── ...
│   └── ...
├── packages/
│   ├── backend/
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── index.ts
│   │   │   └── ...
│   │   └── ...
│   ├── frontend/
│   │   ├── package.json
│   │   ├── src/
│   │   │   ├── index.ts
│   │   │   └── ...
│   │   └── ...
│   └── ...
└── ...

目录结构介绍

• README.md: 项目的基本介绍文档。
• package.json: 项目的依赖管理文件。
• tsconfig.json: TypeScript 配置文件。
• lerna.json: Lerna 多包管理配置文件。
• backstage.json: Backstage 配置文件。
• templates/: 存放各种软件模板的目录。
  • template1/, template2/, ...: 具体的软件模板目录，包含模板配置文件和说明文档。
• plugins/: 存放各种插件的目录。
  • plugin1/, plugin2/, ...: 具体的插件目录，包含插件的源代码和依赖管理文件。
• packages/: 存放后端和前端包的目录。
  • backend/, frontend/: 具体的后端和前端包目录，包含各自的源代码和依赖管理文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 packages/backend 和 packages/frontend 目录下。

后端启动文件

• packages/backend/src/index.ts: 后端服务的入口文件，负责启动后端服务。

前端启动文件

• packages/frontend/src/index.tsx: 前端应用的入口文件，负责启动前端应用。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个部分：

package.json

package.json 文件位于项目根目录下，包含了项目的依赖、脚本命令等信息。

{
  "name": "software-templates",
  "version": "1.0.0",
  "scripts": {
    "start": "backstage-cli start",
    "build": "backstage-cli build",
    "test": "backstage-cli test"
  },
  "dependencies": {
    "@backstage/core": "^1.0.0",
    "@backstage/plugin-catalog": "^1.0.0",
    // 其他依赖
  },
  "devDependencies": {
    "@types/node": "^14.0.0",
    "typescript": "^4.0.0"
  }
}

tsconfig.json

tsconfig.json 文件位于项目根目录下，包含了 TypeScript 的编译配置。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src"]
}

software-templatesBackstage Software Templates for creating a new software component项目地址:https://gitcode.com/gh_mirrors/so/software-templates