FHIR Works on AWS 部署项目启动和配置教程

FHIR Works on AWS 部署项目启动和配置教程

fhir-works-on-aws-deployment A serverless implementation of the FHIR standard that enables users to focus more on their business needs/uniqueness rather than the FHIR specification 项目地址: https://gitcode.com/gh_mirrors/fh/fhir-works-on-aws-deployment

1. 项目目录结构及介绍

FHIR Works on AWS 部署项目是一个开源项目，旨在帮助用户在AWS上部署FHIR服务器。以下是项目的目录结构及各部分的简要介绍：

• ./bin: 存放可执行脚本。
• ./bulkExport: 用于批量导出数据的脚本和配置文件。
• ./cloudformation: AWS CloudFormation模板文件，用于自动部署资源。
• ./compiledImplementationGuides: 存储编译后的实现指南。
• ./ddbToEsLambda: 转换DynamoDB数据到Elasticsearch的Lambda函数代码。
• ./docker: Docker相关文件。
• ./integration-tests: 集成测试代码和配置。
• ./javaHapiValidatorLambda: 用于验证FHIR资源的Java Lambda函数代码。
• ./lib: 项目依赖的库和模块。
• ./postman: Postman集合，用于API测试。
• ./resources: 存储资源文件，如配置模板、脚本等。
• ./scripts: 运行项目所需的脚本。
• ./src: 源代码目录，包含项目的核心逻辑。
• ./test: 单元测试和测试用例。
• ./updateSearchMappings: 更新搜索映射的脚本。

其他文件包括：

• .dockerignore: Docker构建时排除的文件列表。
• .eslintignore: ESLint忽略的文件列表。
• .gitignore: Git忽略的文件列表。
• CHANGELOG.md: 项目更新日志。
• CODEOWNERS: 代码所有者文件，定义了代码维护者。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• CUSTOMIZE.md: 定制化指南。
• DEVELOPMENT.md: 开发指南。
• INSTALL.md: 安装指南。
• LICENSE: 项目许可证信息。
• NOTICE: 通知文件。
• README.md: 项目说明文件。
• THIRD-PARTY: 第三方库和工具的信息。
• USING_IMPLEMENTATION_GUIDES.md: 使用实现指南的文档。
• USING_MULTI_TENANCY.md: 多租户部署文档。
• USING_SUBSCRIPTIONS.md: 使用订阅的文档。
• cdk.json: AWS Cloud Development Kit配置文件。
• codecov.yml: CodeCov配置文件。
• package.json: Node.js项目配置文件。
• serverless.yaml: Serverless Framework配置文件。
• tsconfig.json: TypeScript配置文件。
• yarn.lock: Yarn锁定文件。

2. 项目的启动文件介绍

项目的启动主要通过serverless命令进行，这个命令会使用serverless.yaml配置文件来部署服务。以下是主要启动文件的介绍：

• serverless.yaml: 这是Serverless Framework的主配置文件，定义了函数、事件、资源和环境变量等。例如，它定义了API Gateway的端点、Lambda函数的配置以及DynamoDB和其他AWS资源的配置。

3. 项目的配置文件介绍

项目中的配置文件用于定义和环境相关的变量和参数，以下是主要的配置文件：

• package.json: 定义了项目的依赖、脚本和元数据。scripts部分包含了运行测试、构建和部署项目的脚本命令。

• tsconfig.json: TypeScript配置文件，定义了项目的编译选项，如模块解析、编译目标等。

• serverless_config.template.json: 这个文件是一个模板，用于生成serverless.yaml中的配置。在实际部署时，可以根据需要修改这个模板来生成不同的serverless.yaml文件。

• config.ts: TypeScript文件，包含了项目运行时的配置信息，如数据库连接信息、API密钥等。在实际部署时，需要根据环境变量或配置文件来调整这些配置。

在部署项目前，确保根据INSTALL.md和DEVELOPMENT.md中的指导完成所有必要的安装和配置步骤。这些文档提供了创建环境、安装依赖和配置项目所需的所有步骤。

fhir-works-on-aws-deployment A serverless implementation of the FHIR standard that enables users to focus more on their business needs/uniqueness rather than the FHIR specification 项目地址: https://gitcode.com/gh_mirrors/fh/fhir-works-on-aws-deployment