Attu 开源项目使用教程

Attu 开源项目使用教程

attuMilvus management GUI项目地址:https://gitcode.com/gh_mirrors/at/attu

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

Attu 项目的目录结构如下：

attu/
├── client/
│   ├── doc/
│   ├── examples/
│   ├── scripts/
│   ├── server/
│   ├── dockerignore
│   ├── gitignore
│   ├── Dockerfile
│   ├── LICENSE
│   ├── README.md
│   ├── README_CN.md
│   ├── attu-k8s-deploy.yaml
│   ├── codecov.yml
│   ├── package.json
│   └── yarn.lock
├── server/
│   ├── ...
├── dockerignore
├── gitignore
├── Dockerfile
├── LICENSE
├── README.md
├── README_CN.md
├── attu-k8s-deploy.yaml
├── codecov.yml
├── package.json
└── yarn.lock

目录结构介绍

• client/: 客户端相关文件和代码。
  • doc/: 文档文件。
  • examples/: 示例代码。
  • scripts/: 脚本文件。
  • server/: 服务器相关文件和代码。
• server/: 服务器相关文件和代码。
• dockerignore: Docker 忽略文件。
• gitignore: Git 忽略文件。
• Dockerfile: Docker 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目英文介绍文档。
• README_CN.md: 项目中文介绍文档。
• attu-k8s-deploy.yaml: Kubernetes 部署文件。
• codecov.yml: Codecov 配置文件。
• package.json: Node.js 项目配置文件。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

客户端启动

1. 进入 client 目录：

   cd client
   

2. 安装依赖：

   yarn install
   

3. 启动开发服务器：

   yarn start
   

服务器启动

1. 进入 server 目录：

   cd server
   

2. 安装依赖：

   yarn install
   

3. 启动开发服务器：

   yarn start
   

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的元数据和依赖信息。以下是一些关键字段：

{
  "name": "attu",
  "version": "1.0.0",
  "description": "Attu is an all-in-one Milvus administration tool.",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "express": "^4.17.1",
    "milvus-sdk-node": "^2.0.0"
  },
  "devDependencies": {
    "eslint": "^7.23.0"
  }
}

Dockerfile

Dockerfile 文件用于构建 Docker 镜像。以下是一个示例：

FROM node:14

WORKDIR /app

COPY package.json yarn.lock ./

RUN yarn install

COPY . .

EXPOSE 3000

CMD ["yarn", "start"]

attu-k8s-deploy.yaml

attu-k8s-deploy.yaml 文件用于 Kubernetes 部署。以下是一个示例：

apiVersion: apps/v1
kind: Deployment
metadata:
  name: attu
spec:
  replicas: 3
  selector:
    matchLabels:
      app: attu
  template:
    metadata:
      labels:
        app: attu
    spec:
      containers:
      - name: attu
        image: attu:latest
        ports:
        - containerPort: 3000

通过以上教程，您可以了解 Attu 项目的目录结构、启动文件和配置文件的基本信息，从而更好地进行开发和部署。

attuMilvus management GUI项目地址:https://gitcode.com/gh_mirrors/at/attu