Skip to content

Commit

Permalink
Udpate readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gmej committed May 12, 2023
1 parent 379beb2 commit 765e373
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,21 @@
---
## Introduction

This repository contains an example of a preprocesing service.

This service does not need to be published to the internet, so no gateway config is needed to proxy any petition. This is an internal service.
This repository contains an example of a preprocesing service. A preprocessing service reads the Package Leaflet of an ePI, and adds semmantic annotations to it.

---
## Hackaton Considerations
This repository serves as an skeleton for a preprocessor service. It is written in typescript and executes an example semantic annotation, adding a simple tag. The preprocessor must add semmantic annotation to the package leaflet sections of the ePI. No other field in the ePI can be edited.

In this example, the preprocessing is done in the [src/controllers/preprocessing.ts](./src/controllers/preprocessing.ts) file, in the `addSemmanticAnnotation` function.

The hackathon participants may write the preprocessor in the way that best suits for them. The only thing that is mandatory is that the preprocessor API complies with the [OpenApi Specification](./openapi.yaml) within this repository. Also, the service must listen for HTTP connections on port 3000.
The hackathon participants may write the preprocessor in the way that best suits for them. Participants can use any programming language, framework or technology. The only thing that is mandatory is that the preprocessor serves an API that is compliant with the [OpenApi Specification](./openapi.yaml) within this repository. Also, the service must listen for HTTP connections on port 3000. Note that this service will not be accessible over the internet when deployed in the Gravitate Health infrastructure, and will be an internal service that is used via the Hackathon web interface.

Participants must provide the image name of the preprocessor to the Hackathon organizers and deployment is automatized.

Participants must fork this proyect into their personal github account.

The way the preprocessor is deployed in the infrascturcure is done with a Github action, which is included in the repository. The action can be found at [.github/workflows/docker-image.yml](./.github/workflows/docker-image.yml), and it builds a Docker image with the syntax `ghcr.io/GITHUB_USERNAME/REPOSITORY_NAME`, and then publishes it to ghcr.io (Github container Registry). The name of this image must be provided to the Hackaton organizers so they can deploy a service running the developed preprocessing service to be tested within the infrastructure. Participants are advised not to edit this Github Action, but if they wanted, they must tag the latest version of the image as `latest`.
The way the preprocessor is deployed in the infrascturcure is done with a Github action, which is included in the repository. The action can be found at [.github/workflows/docker-image.yml](./.github/workflows/docker-image.yml), and it builds a Docker image with the syntax `ghcr.io/GITHUB_USERNAME/REPOSITORY_NAME`, tagging the latest version of the image as `latest`, and then publishes it to ghcr.io (Github container Registry). The name of this image must be provided to the Hackaton organizers so they can deploy a service running the developed preprocessing service to be tested within the infrastructure. Participants are advised not to edit this Github Action.

Once the preprocessor is deployed to the infrastructure, the name of the preprocessor will be presented in the Hackathon frontend as `preprocessing-teamN`, being `N` the name of the team.

Expand All @@ -58,6 +56,8 @@ metadata:
eu.gravitate-health.fosps.preprocessing: "true"
```
NOTE: This service does not need to be published to the internet, so no gateway config is needed to proxy any petition. This is an internal service.
---
## Usage
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 765e373

Please sign in to comment.