Insights 项目使用教程

Insights 项目使用教程

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

Insights 是一个开源的自托管商业智能平台，它的目录结构如下：

.insights/
├── .github/               # GitHub 工作流和模板
├── .vscode/              # Visual Studio Code 设置
├── docs/                 # 文档文件夹
├── packages/             # 项目依赖的包
├── scripts/              # 脚本文件夹
├── editorconfig          # 编辑器配置文件
├── eslintrc              # ESLint 配置文件
├── gitignore             # Git 忽略文件
├── npmignore             # npm 忽略文件
├── LICENSE               # 项目许可证
├── README.md             # 项目说明文件
├── TODO.md               # 待办事项文件
├── package.json          # 项目配置文件
├── tsconfig.json         # TypeScript 配置文件
└── yarn.lock             # yarn 锁定文件

• .github/: 包含了GitHub Actions的工作流文件和Pull Request模板等。
• .vscode/: 包含了Visual Studio Code的配置文件，用于统一开发环境。
• docs/: 存放项目文档的文件夹。
• packages/: 存放项目的依赖包。
• scripts/: 存放项目使用的脚本文件。
• editorconfig: 定义了代码编辑器的配置，以保持代码风格的一致性。
• eslintrc: 定义了ESLint的配置，用于保持代码质量。
• gitignore: 定义了Git应该忽略的文件和文件夹。
• npmignore: 定义了npm打包时应该忽略的文件和文件夹。
• LICENSE: 项目使用的许可证信息，本项目采用MIT许可证。
• README.md: 项目的基本介绍和说明。
• TODO.md: 项目开发中的待办事项列表。
• package.json: 项目配置文件，包含了项目依赖和脚本。
• tsconfig.json: TypeScript配置文件，定义了TypeScript的编译选项。
• yarn.lock: 记录了项目依赖的精确版本，用于确保在不同环境中安装的依赖一致。

2. 项目的启动文件介绍

Insights 项目的启动主要依赖于 package.json 文件中定义的脚本。

在 package.json 文件中，可以找到以下启动脚本：

"scripts": {
  "init": "insights init",
  "start": "insights start",
  // 其他脚本...
}

• init: 这个脚本用于初始化项目配置和运行时数据文件夹 .insights。
• start: 这个脚本用于启动Insights服务。

用户可以通过以下命令启动项目：

yarn init       # 或者 npm run init
yarn start      # 或者 npm start

3. 项目的配置文件介绍

Insights 项目的配置主要通过 package.json 文件进行。以下是 package.json 文件的一些关键配置项：

{
  "name": "insights",
  "version": "1.0.0",
  "description": "Open Source Self-Hosted Business Intelligence Platform",
  "main": "index.js",
  "scripts": {
    "init": "insights init",
    "start": "insights start"
    // 其他脚本...
  },
  "dependencies": {
    // 项目依赖...
  },
  "devDependencies": {
    // 开发依赖...
  },
  "author": "Marius Andra",
  "license": "MIT",
  // 其他配置...
}

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的入口文件。
• scripts: 项目的脚本命令，包括初始化和启动脚本。
• dependencies: 项目的运行时依赖。
• devDependencies: 项目的开发时依赖。
• author: 项目的作者。
• license: 项目的许可证类型。

这个配置文件定义了项目的基本信息和运行逻辑，是项目启动和运行的基础。