Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jieyouxu/gosh-fhirworks2020-docugen
Document generation tool for the GOSH Drive FHIRworks API.
https://github.com/jieyouxu/gosh-fhirworks2020-docugen
Last synced: 3 days ago
JSON representation
Document generation tool for the GOSH Drive FHIRworks API.
- Host: GitHub
- URL: https://github.com/jieyouxu/gosh-fhirworks2020-docugen
- Owner: jieyouxu
- License: mit
- Created: 2020-03-02T09:57:41.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-21T14:54:22.000Z (almost 5 years ago)
- Last Synced: 2024-11-06T00:39:36.316Z (about 2 months ago)
- Language: Rust
- Size: 16.3 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GOSH-FHIRworks2020-Docugen
[](https://codecov.io/gh/jieyouxu/GOSH-FHIRworks2020-Docugen)
[](https://travis-ci.com/jieyouxu/GOSH-FHIRworks2020-Docugen)
A document generation tool `Docugen` for the GOSH Drive FHIRworks API.
## Submodules
```text
.
├── FHIRworks_2020 // (intermediate web API submodule)
└── gosh_fhirworks2020_docugen // (this tool)
```
The submodule `FHIRworks_2020` contains the intermediate web API for
interpolation between the backend FHIRworks API and the front-end `Docugen`
tool.
Run the `dotnet-azure-fhir-web-api` and bind it to `https://localhost:5001` so
the front-end tooling can utilize this intermediate endpoint. If alternative
address / port is required, see the configuration section to let `docugen`
know.
## Building and Running
- The project is written in [rust](https://github.com/rust-lang/rust).
- The build tool is [cargo](https://github.com/rust-lang/cargo/).
The following commands assume you are in the `gosh_fhirworks2020_docugen`
directory.
### Development Build
```
cargo build
```
To run the binary directly, run
```
cargo run
```
To see what options are available, run
```
cargo run -- --help
```
```
FHIRworks2020 docugen 0.1.0
Small CLI tool to fetch data from a FHIR API endpoint and fill out a document template.
USAGE:
docugen_bin [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
-v Sets the level of logging verbosity.
-V, --version Prints version information
OPTIONS:
-c, --config Sets config from custom file.
ARGS:
Select the endpoint to use, e.g. `/api/Patient`. Configure the IP address and port in the
configuration file.
Select the template to fill the data fetched from the endpoint.
```
### Production/Release Build
Default optimization level is `-O3`.
```
cargo build --release
```
## Documentation
Deployed at [docugen](https://jieyouxu.github.io/GOSH-FHIRworks2020-Docugen/docugen/index.html).
## Configuration
To configure the tooling, copy the example `config.example.toml` configuration
file.
```bash
cd gosh_fhirworks2020_docugen
cp config.example.toml config.toml
```
## References
Third-party libraries used:
```
[dependencies]
lazy_static = "1.4.0"
toml = "0.5.6"
serde = { version = "1.0.104", features = ["derive"] }
serde_json = "1.0.48"
log = "0.4.8"
pom = "3.1.0"
clap = { version = "2.33.0", features = ["color"] }
pretty_env_logger = "0.4.0"
reqwest = { version = "0.10.4", features = ["json"] }
tokio = { version = "0.2.13", features = ["full"] }
[dev-dependencies]
pretty_assertions = "0.6.1"
```
See `gosh_fhirworks2020_docugen/Cargo.toml` for exact external crate names,
versions and enabled features.