https://github.com/creek-service/creek-platform

The base of the Creek platform
https://github.com/creek-service/creek-platform

Last synced: 26 days ago
JSON representation

The base of the Creek platform

• Host: GitHub
• URL: https://github.com/creek-service/creek-platform
• Owner: creek-service
• License: apache-2.0
• Created: 2022-07-26T12:49:17.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T03:27:50.000Z (7 months ago)
• Last Synced: 2024-11-01T04:16:54.110Z (7 months ago)
• Language: Java
• Size: 517 KB
• Stars: 4
• Watchers: 0
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Coverage Status](https://coveralls.io/repos/github/creek-service/creek-platform/badge.svg?branch=main)](https://coveralls.io/github/creek-service/creek-platform?branch=main)

[![build](https://github.com/creek-service/creek-platform/actions/workflows/build.yml/badge.svg)](https://github.com/creek-service/creek-platform/actions/workflows/build.yml)

[![CodeQL](https://github.com/creek-service/creek-platform/actions/workflows/codeql.yml/badge.svg)](https://github.com/creek-service/creek-platform/actions/workflows/codeql.yml)

[![Maven Central](https://img.shields.io/maven-central/v/org.creekservice/creek-platform-metadata.svg)](https://central.sonatype.dev/search?q=creek-platform-*)

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/creek-service/creek-platform/badge)](https://api.securityscorecards.dev/projects/github.com/creek-service/creek-platform)

[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6899/badge)](https://bestpractices.coreinfrastructure.org/projects/6899)

# Creek Platform

This repository defines base types, generally interfaces, used to define architectural components, 

such as a 'service' or an 'aggregate', and the resources they use.  Additionally, it defines

a library for inspecting components, extracting resources and determining which resources 

need initialising for which components.

Users of Creek will implement the service and aggregate descriptor interfaces defined in this repository.

They should not directly implement the base resource interfaces. These are designed to be extended by 

extensions to Creek.

See [CreekService.org](https://www.creekservice.org) for info on Creek Service.

## Modules

The repo contains the following modules:

* **[metadata](metadata)** [[JavaDocs](https://javadoc.io/doc/org.creekservice/creek-platform-metadata)]: A dependency-free library that defines the interfaces used to describe platform components and resources.

* **[resource](resource)** [[JavaDocs](https://javadoc.io/doc/org.creekservice/creek-platform-resource)]: A common library for working with descriptors and resources.