SUSHI 开源项目使用教程

SUSHI 开源项目使用教程

sushiSUSHI (aka "SUSHI Unshortens Short Hand Inputs") is a reference implementation command-line interpreter/compiler for FHIR Shorthand (FSH).项目地址:https://gitcode.com/gh_mirrors/sush/sushi

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

SUSHI（Smart User Story Synthesizer）项目的目录结构如下：

sushi/
├── bin/
│   └── sushi.js
├── config/
│   ├── default.yaml
│   └── custom.yaml
├── docs/
│   └── README.md
├── src/
│   ├── index.js
│   └── utils/
│       └── helper.js
├── test/
│   └── sushi.test.js
├── .gitignore
├── LICENSE
├── package.json
└── README.md

目录结构介绍

• bin/: 包含项目的可执行文件。
• config/: 包含项目的配置文件。
• docs/: 包含项目的文档文件。
• src/: 包含项目的主要源代码。
• test/: 包含项目的测试文件。
• .gitignore: Git忽略文件。
• LICENSE: 项目的许可证。
• package.json: 项目的依赖管理文件。
• README.md: 项目的主文档文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，名为 sushi.js。该文件是项目的入口点，负责初始化项目并启动服务。

#!/usr/bin/env node

const main = require('../src/index');
main();

启动文件介绍

• #!/usr/bin/env node: 指定使用Node.js执行该脚本。
• const main = require('../src/index'): 引入主模块。
• main(): 调用主模块的入口函数。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包含 default.yaml 和 custom.yaml 两个文件。

default.yaml

default.yaml 是项目的默认配置文件，包含所有必要的配置项。

server:
  port: 3000
  host: 'localhost'
database:
  host: 'localhost'
  port: 27017
  name: 'sushi_db'

custom.yaml

custom.yaml 是用户自定义的配置文件，可以覆盖 default.yaml 中的配置项。

server:
  port: 8080

配置文件介绍

• server: 服务器的配置项，包括端口和主机名。
• database: 数据库的配置项，包括主机、端口和数据库名。

通过以上配置文件，用户可以根据需要调整项目的运行参数。

sushiSUSHI (aka "SUSHI Unshortens Short Hand Inputs") is a reference implementation command-line interpreter/compiler for FHIR Shorthand (FSH).项目地址:https://gitcode.com/gh_mirrors/sush/sushi