开源项目启动与配置教程

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

本项目email_vocabulary旨在通过AWS基础设施每日自动发送包含三个指定语言和难度级别的单词及其翻译和例句的邮件。以下是项目的目录结构及各部分功能的简要介绍：

• images/: 存放项目相关图片的文件夹。
• .gitignore: 指定Git应该忽略的文件和文件夹。
• .pre-commit-config.yaml: pre-commit配置文件，用于在提交代码前自动运行一些检查。
• .tflint.hcl: tflint配置文件，用于检查Terraform代码风格问题。
• CONTRIBUTING.md: 向贡献者说明如何参与项目。
• LICENSE: 项目的许可证文件，本项目采用MIT协议。
• README.md: 项目的说明文件，包含项目的概述、安装、配置和使用等信息。
• cloudwatch.tf: 定义AWS CloudWatch资源的Terraform文件。
• deployment_package.zip: Lambda函数的部署包。
• dynamodb.tf: 定义AWS DynamoDB资源的Terraform文件。
• iam.tf: 定义AWS IAM角色的Terraform文件。
• lambda_function.py: Lambda函数的Python代码，负责选择单词并发送邮件。
• main.tf: 主Terraform配置文件。
• requirements.txt: 项目依赖的Python包列表。
• setup.sh: 用于创建Lambda部署包的shell脚本。
• ssm.tf: 定义AWS SSM Parameter Store资源的Terraform文件。
• terraform.tfvars.example: Terraform变量示例文件。
• variables.py: 项目的配置文件，包含项目的可变参数。
• variables.tf: 定义Terraform变量的文件。

2. 项目的启动文件介绍

项目的启动主要是通过Terraform来部署AWS资源。以下是主要的启动文件：

• main.tf: 主Terraform配置文件，定义了项目所需要创建的AWS资源，包括Lambda函数、DynamoDB表、IAM角色等。
• variables.tf: 定义了在部署过程中可能需要变化的一些变量，例如AWS区域的名称、S3桶的名称等。

要启动项目，首先需要配置terraform.tfvars文件，然后执行以下命令：

terraform init
terraform plan
terraform apply

这些命令将初始化Terraform环境，规划要部署的资源，并最终应用这些资源。

3. 项目的配置文件介绍

项目的配置主要通过variables.py和terraform.tfvars.example进行。

• variables.py: 包含了项目的可配置参数，如AWS密钥、邮箱地址、单词语言和难度级别等。
• terraform.tfvars.example: 提供了Terraform变量的示例，包括AWS访问密钥、秘密密钥、S3桶名称等。在实际部署时，需要将此文件复制为terraform.tfvars，并根据实际情况填写相应的值。

确保正确填写所有配置文件后，项目即可按预期运行。