Amazon Cognito 无密码认证项目教程
1. 项目目录结构及介绍
amazon-cognito-passwordless-auth/
├── client/
│ ├── src/
│ └── package.json
├── cdk/
│ ├── bin/
│ ├── lib/
│ └── package.json
├── end-to-end-example/
│ ├── src/
│ └── package.json
├── drawings/
├── github/
│ └── workflows/
├── .eslintignore
├── .eslintrc.cjs
├── .gitignore
├── .npmignore
├── .prettierignore
├── .prettierrc
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── CUSTOMIZE-AUTH.md
├── FIDO2.md
├── LICENSE
├── MAGIC-LINKS.md
├── NOTICE
├── README.md
├── SMS-OTP-STEPUP.md
└── dist-create-package.cjs
目录结构介绍
-
client/: 前端代码目录,包含React和React Native的实现。
- src/: 前端源代码。
- package.json: 前端项目的依赖配置文件。
-
cdk/: AWS CDK(Cloud Development Kit)代码目录,用于部署后端资源。
- bin/: CDK应用的入口文件。
- lib/: CDK构造和逻辑代码。
- package.json: CDK项目的依赖配置文件。
-
end-to-end-example/: 端到端示例代码目录,包含完整的应用示例。
- src/: 示例应用的源代码。
- package.json: 示例项目的依赖配置文件。
-
drawings/: 项目相关的图表和文档。
-
github/workflows/: GitHub Actions工作流配置文件。
-
.eslintignore: ESLint忽略文件配置。
-
.eslintrc.cjs: ESLint配置文件。
-
.gitignore: Git忽略文件配置。
-
.npmignore: npm发布时忽略的文件配置。
-
.prettierignore: Prettier忽略文件配置。
-
.prettierrc: Prettier配置文件。
-
CODE_OF_CONDUCT.md: 项目行为准则。
-
CONTRIBUTING.md: 贡献指南。
-
CUSTOMIZE-AUTH.md: 自定义认证流程的文档。
-
FIDO2.md: FIDO2认证相关文档。
-
LICENSE: 项目许可证。
-
MAGIC-LINKS.md: 魔法链接认证相关文档。
-
NOTICE: 项目通知文件。
-
README.md: 项目主文档。
-
SMS-OTP-STEPUP.md: SMS OTP认证相关文档。
-
dist-create-package.cjs: 打包脚本。
2. 项目启动文件介绍
CDK 启动文件
- cdk/bin/index.ts: CDK应用的入口文件,负责初始化和部署CDK栈。
前端启动文件
- client/src/index.tsx: 前端应用的入口文件,负责初始化React应用。
端到端示例启动文件
- end-to-end-example/src/index.tsx: 端到端示例应用的入口文件,负责初始化示例应用。
3. 项目配置文件介绍
CDK 配置文件
- cdk/package.json: 包含CDK项目的依赖和脚本配置。
前端配置文件
- client/package.json: 包含前端项目的依赖和脚本配置。
端到端示例配置文件
- end-to-end-example/package.json: 包含端到端示例项目的依赖和脚本配置。
其他配置文件
- .eslintrc.cjs: ESLint配置文件,定义代码风格和规则。
- .prettierrc: Prettier配置文件,定义代码格式化规则。
- .gitignore: Git忽略文件配置,指定哪些文件和目录不应被Git跟踪。
- .npmignore: npm发布时忽略的文件配置,指定哪些文件不应包含在npm包中。
通过以上介绍,您可以更好地理解amazon-cognito-passwordless-auth
项目的结构和配置,从而更高效地进行开发和部署。