Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bluehalo/node-cds-hooks-starter
Open Source CDS Hooks starter project. Start building your CDS Hooks App right away
https://github.com/bluehalo/node-cds-hooks-starter
Last synced: about 1 month ago
JSON representation
Open Source CDS Hooks starter project. Start building your CDS Hooks App right away
- Host: GitHub
- URL: https://github.com/bluehalo/node-cds-hooks-starter
- Owner: bluehalo
- License: mit
- Created: 2020-06-09T22:00:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T08:27:44.000Z (almost 2 years ago)
- Last Synced: 2024-04-11T00:42:09.800Z (9 months ago)
- Language: JavaScript
- Homepage: https://asymmetrik.com/healthcare
- Size: 2.38 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Node CDS Service Starter
This is a starter project for a CDS Service. It is designed to reduce the development time
for developers by solving the boring parts for them.## Getting started
### Install
```
yarn install
```### Start Nodemon
```
yarn develop
```Or: Just node
```
yarn start
```### Test with CDS Hooks Sandbox
![CDS Sandbox](./docs/CDSSandbox.png)
CDS Hooks Sandbox is a fantastic tool that simulates calls to your CDS Service, where you can then return different **Cards**.
Out of the box, **node-cds-service-starter** returns an **Information** card. Read about the different types of card on [CDS Hooks](https://cds-hooks.org/).#### Register Your Service
Register your service by selected "Add CDS Service" in the upper right.
![Add CDS Services](./docs/AddCDSServices.png)
Add your discovery endpoint where the CDS Hooks Sandbox can find the hooks you
would like to subscribe to. If you are developing locally, then you would put **http://localhost:3000/cds-services**We can now see in our Sandbox that the default information card is being displayed.
![Displayed](./docs/Displayed.png)
## Default Card
There is one information card that can be used as an example already supplied in this project.
```json
{
"cards": [
{
"summary": "Summary: Hello world. Hook: 'patient-view' -- Patient smart-1288992",
"detail": "Detail: Hello world. Hook: 'patient-view' -- Patient smart-1288992",
"source": {
"label": "CDS Service Starter",
"url": "https://example.com"
},
"indicator": "info"
}
]
}
```