https://github.com/super-flat/lagom-pb

Scala Developer velocity in lagom development using protocol buffer.
https://github.com/super-flat/lagom-pb

distributed-systems event-driven event-sourcing grpc lagom lagom-framework microservice play-framework protobuf protocol-buffer reactive scala scalapb

Last synced: 4 months ago
JSON representation

Scala Developer velocity in lagom development using protocol buffer.

• Host: GitHub
• URL: https://github.com/super-flat/lagom-pb
• Owner: super-flat
• License: apache-2.0
• Archived: true
• Created: 2020-05-23T17:45:04.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-12-26T04:14:30.000Z (over 3 years ago)
• Last Synced: 2024-09-30T15:41:32.768Z (8 months ago)
• Topics: distributed-systems, event-driven, event-sourcing, grpc, lagom, lagom-framework, microservice, play-framework, protobuf, protocol-buffer, reactive, scala, scalapb
• Language: Scala
• Homepage:
• Size: 1.02 MB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 31
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# lagom-pb = lagom + protocol buffer

[![Build Status](https://www.travis-ci.com/super-flat/lagom-pb.svg?branch=master)](https://www.travis-ci.com/super-flat/lagom-pb)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/59e8747c2777466cb75d73d5fea8c8a8)](https://app.codacy.com/gh/super-flat/lagom-pb?utm_source=github.com&utm_medium=referral&utm_content=super-flat/lagom-pb&utm_campaign=Badge_Grade_Dashboard)

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

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.superflat/lagompb-core_2.13/badge.svg)]((https://maven-badges.herokuapp.com/maven-central/io.superflat/lagompb-core_2.13))

[![Snapshot Artifacts][Badge-SonatypeSnapshots]][Link-SonatypeSnapshots]

[![Join the chat at https://gitter.im/super-flat/lagom-pb](https://badges.gitter.im/super-flat/lagom-pb.svg)](https://gitter.im/super-flat/lagom-pb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Scala Developer velocity in [lagom](https://www.lagomframework.com/documentation/1.6.x/scala/Home.html) development

using protocol buffer.

This library helps write lagom microservices easily by making use of protocol buffer messages to define the es/cqrs core

components like _**api requests/responses**_, _**grpc services**_, _**events**_, _**commands**_ and _**state**_.

## Features

- Implementation of an HTTP/Json based microservice using REST interfaces by defining _**api requests and responses as

  protobuf messages**_.

- Implementation of a gRPC based microservice using protocol buffer messages. More info: [gRPC](https://grpc.io/).

- ReadSide in-built battery via ([Akka Projection](https://doc.akka.io/docs/akka-projection/current/)).

- Easy definition of aggregate root, events and command handlers.

- Pure testable functions for events and commands handlers.

- Easy definition of api service descriptors.

- Easy implementation of api service either with message broker api or without.

- Metadata adds some `revision number` that can help easily implement optimistic lock.

- At every event handled a snapshot of the aggregate state with the metadata are made available for the readSide.

- All events, snapshots and readSide offsets are persisted to Postgres SQL.

- Encryption trait to enable events and snapshots encryption.

## Documentation

Documentation is available at [lagom-pb wiki](https://github.com/super-flat/lagom-pb/wiki) at the moment.

## Sample Project

There is a demo application built on top the library that can be found

here [Sample](https://github.com/super-flat/lagom-pb-sample)

## License

This software is licensed under the Apache 2 license, quoted below.

Copyright © 2020 superflat

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the

License. You may obtain a copy of the License at

[http://www.apache.org/licenses/LICENSE-2.0]

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "

AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific

language governing permissions and limitations under the License.

[Link-SonatypeSnapshots]: https://oss.sonatype.org/content/repositories/snapshots/io/superflat/lagompb-core_2.13/ "Sonatype Snapshots"

[Badge-SonatypeSnapshots]: https://img.shields.io/nexus/s/https/oss.sonatype.org/io.superflat/lagompb-core_2.13.svg "Sonatype Snapshots"