{"id":22402486,"url":"https://github.com/lblod/lpdc-publish-service","last_synced_at":"2025-03-27T00:42:07.048Z","repository":{"id":93796489,"uuid":"520092410","full_name":"lblod/lpdc-publish-service","owner":"lblod","description":"Service in charge of publishing LPDC data to ldes-feed","archived":false,"fork":false,"pushed_at":"2024-03-26T08:28:12.000Z","size":497,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-04-16T06:37:05.443Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lblod.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-01T12:01:04.000Z","updated_at":"2024-05-15T19:53:39.403Z","dependencies_parsed_at":"2023-04-04T17:05:49.765Z","dependency_job_id":"2c106fb7-0197-46f3-8f31-384e5a618e4c","html_url":"https://github.com/lblod/lpdc-publish-service","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lblod%2Flpdc-publish-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lblod%2Flpdc-publish-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lblod%2Flpdc-publish-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lblod%2Flpdc-publish-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lblod","download_url":"https://codeload.github.com/lblod/lpdc-publish-service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245760897,"owners_count":20667893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-05T09:13:12.390Z","updated_at":"2025-03-27T00:42:07.029Z","avatar_url":"https://github.com/lblod.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LPDC (Lokale Producten- en Dienstencatalogus) - Publishing Service\n\n_Note_: Documentation is structured using [The software guidebook by Simon Brown](https://leanpub.com/documenting-software-architecture).\n\nLPDC Publishing Service is part of [LPDC - Digitaal loket](https://github.com/lblod/app-lpdc-digitaal-loket/tree/development). This contains general documentation. Specific documentation to be found in this project.\n\n# 1. Context\n\nThis service publishes sent documents to a LDES feed.\nIt requests document regularly using `cron`.\n\n# 2. Functional Overview\n\n# 3. Quality Attributes\n\n# 4. Constraints\n\n# 5. Principles\n\n# 6. Software Architecture\n\n# 7. Code\n\n# 8. Data\n\n# 9. Infrastructure Architecture\n\n# 10. Deployment\n\n## Configuration\n\nIn order to configure this service, 3 environment variables need to be defined:\n\n- `CRON_PATTERN` : for defining cron timed executions of the routine.\n- `LDES_ENDPOINT`: url of the fragmenter on which the service will publish\n- `LDES_FOLDER`:  *(optional)* folder of the fragmenter, the service will publish in.\n- `LDES_ENDPOINT_HEADER_\u003ckey\u003e`: [string]: A header key-value combination which should be send as part of the headers to the LDES ENDPOINT. E.g. LDES_ENDPOINT_HEADER_X-API-KEY: \u003capi_key\u003e.\n\n## Docker-compose configuration\n\nFor using this service in a docker-compose stack, the following example can be used\n\n```\nlpdc-push-to-producer:\n    image: lpdc-push-to-producer # image will be soon available\n    environment:\n      NODE_ENV: \"development\"\n      LDES_ENDPOINT: \"http://fragmentation-producer:3000/\"\n      LDES_FOLDER: \"foldername\"\n```\n\n## Release a new version\nWe use [release-it](https://github.com/release-it/release-it/tree/main) to make a new release.\n\n```shell\n  npm run release\n```\n\n# 11. Operation and Support\n\n# 12. Development Environment\n\n# 13. Decision Log\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flblod%2Flpdc-publish-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flblod%2Flpdc-publish-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flblod%2Flpdc-publish-service/lists"}