Elastic Search UI 项目教程

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

Elastic Search UI 项目的目录结构如下：

search-ui/
├── docs/
│   ├── README.md
│   └── ...
├── examples/
│   ├── basic/
│   ├── advanced/
│   └── ...
├── packages/
│   ├── react-search-ui/
│   ├── search-ui-app-search-connector/
│   └── ...
├── scripts/
│   └── ...
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── ...

目录结构介绍：

• docs/: 包含项目的文档文件，如 README.md 等。
• examples/: 包含项目的示例代码，分为 basic 和 advanced 等不同难度级别的示例。
• packages/: 包含项目的各个子包，如 react-search-ui 和 search-ui-app-search-connector 等。
• scripts/: 包含项目的脚本文件，用于自动化任务。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件。
• package.json: 项目的配置文件，包含依赖项、脚本等信息。
• README.md: 项目的介绍文件，通常包含项目的概述、安装和使用说明等。

2. 项目的启动文件介绍

在 examples/basic 目录下，项目的启动文件通常是 index.js 或 App.js。以下是一个简单的启动文件示例：

// examples/basic/index.js
import React from 'react';
import ReactDOM from 'react-dom';
import { SearchProvider, Results, SearchBox } from '@elastic/react-search-ui';
import { AppSearchAPIConnector } from '@elastic/search-ui-app-search-connector';

const connector = new AppSearchAPIConnector({
  searchKey: "search-soaewu2ye6uc45dr8mcd54v8",
  engineName: "national-parks-demo",
  hostIdentifier: "host-2376rb"
});

const config = {
  apiConnector: connector
};

const App = () => (
  <SearchProvider config={config}>
    <div>
      <SearchBox />
      <Results titleField="title" urlField="nps_link" />
    </div>
  </SearchProvider>
);

ReactDOM.render(<App />, document.getElementById('root'));

启动文件介绍：

• SearchProvider: 提供搜索上下文，配置搜索连接器。
• Results: 显示搜索结果的组件。
• SearchBox: 提供搜索框的组件。
• AppSearchAPIConnector: 连接到 Elastic App Search 的连接器。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的依赖项、脚本等信息。以下是一个示例：

{
  "name": "search-ui",
  "version": "1.0.0",
  "description": "A React-based UI library for building search experiences.",
  "main": "index.js",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "@elastic/react-search-ui": "^1.0.0",
    "@elastic/search-ui-app-search-connector": "^1.0.0",
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3"
  },
  "devDependencies": {
    "eslint": "^7.23.0",
    "prettier": "^2.2.1"
  },
  "browserslist": {
    "production": [
      ">0.2%",
      "not dead",
      "not op_mini all"
    ],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  }
}

配置文件介绍：

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的入口文件。
• scripts: 定义了项目的脚本命令，如 start、build、test 等。
• dependencies: 项目的生产依赖项。
• devDependencies: 项目的开发依赖项。
• browserslist: 定义了项目支持的浏览器列表。

通过以上内容，您可以快速了解 Elastic Search UI 项目的目录结构、启动文件和配置文件。希望这份教程对您有所帮助！