AWS GenAI LLM Chatbot 项目教程

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

aws-genai-llm-chatbot/
├── bin/
│   └── cli.js
├── devcontainer/
├── github/
│   └── workflows/
├── docs/
├── integtests/
├── lib/
│   └── index.ts
├── scripts/
├── tests/
├── .eslintignore
├── .eslintrc.cjs
├── .flake8
├── .gitallowed
├── .gitignore
├── .graphqlconfig.yml
├── .npmignore
├── .prettierignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── NOTICE
├── README.md
├── bandit.yaml
├── cdk.json
├── package-lock.json
├── package.json
├── prettier.config.js
├── pytest_requirements.txt
├── tsconfig.json

目录结构介绍

• bin/: 包含项目的启动文件 cli.js。
• devcontainer/: 开发容器配置文件。
• github/workflows/: GitHub Actions 工作流配置文件。
• docs/: 项目文档。
• integtests/: 集成测试相关文件。
• lib/: 项目的主要代码库，包含 index.ts 文件。
• scripts/: 项目脚本文件。
• tests/: 测试相关文件。
• .eslintignore: ESLint 忽略配置文件。
• .eslintrc.cjs: ESLint 配置文件。
• .flake8: Flake8 配置文件。
• .gitallowed: Git 允许的文件配置。
• .gitignore: Git 忽略配置文件。
• .graphqlconfig.yml: GraphQL 配置文件。
• .npmignore: npm 忽略配置文件。
• .prettierignore: Prettier 忽略配置文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• NOTICE: 项目通知文件。
• README.md: 项目介绍文件。
• bandit.yaml: Bandit 配置文件。
• cdk.json: AWS CDK 配置文件。
• package-lock.json: npm 包锁定文件。
• package.json: npm 包配置文件。
• prettier.config.js: Prettier 配置文件。
• pytest_requirements.txt: pytest 依赖文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

bin/cli.js

bin/cli.js 是项目的启动文件。它负责初始化项目并启动应用程序。该文件通常包含以下内容：

• 导入必要的模块和库。
• 配置应用程序的初始设置。
• 启动应用程序的主逻辑。

3. 项目的配置文件介绍

cdk.json

cdk.json 是 AWS CDK 的配置文件，用于定义项目的配置和行为。它通常包含以下内容：

• app: 指定应用程序的入口文件。
• context: 存储项目的上下文信息，如环境变量、配置参数等。
• requireApproval: 定义部署时的审批级别。

package.json

package.json 是 npm 包配置文件，包含项目的元数据和依赖项。它通常包含以下内容：

• name: 项目名称。
• version: 项目版本。
• scripts: 定义可执行的脚本命令。
• dependencies: 项目依赖的 npm 包。
• devDependencies: 开发环境依赖的 npm 包。

tsconfig.json

tsconfig.json 是 TypeScript 配置文件，用于定义 TypeScript 编译器的选项。它通常包含以下内容：

• compilerOptions: 编译器选项，如目标版本、模块系统、输出目录等。
• include: 指定包含的文件或目录。
• exclude: 指定排除的文件或目录。

通过以上配置文件，可以有效地管理和配置 AWS GenAI LLM Chatbot 项目。