https://github.com/octonato/user-registry-choreography-saga

https://github.com/octonato/user-registry-choreography-saga

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/octonato/user-registry-choreography-saga
• Owner: octonato
• Created: 2023-10-18T19:45:17.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-13T14:07:16.000Z (about 1 year ago)
• Last Synced: 2024-10-12T16:16:53.262Z (about 1 month ago)
• Language: Java
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# user-registry

To understand the Kalix concepts that are the basis for this example, see [Designing services](https://docs.kalix.io/java/development-process.html) in the documentation.

This project contains the framework to create a Kalix service. To understand more about these components, see [Developing services](https://docs.kalix.io/services/) and check Spring-SDK [official documentation](https://docs.kalix.io/spring/index.html). Examples can be found [here](https://github.com/lightbend/kalix-jvm-sdk/tree/main/samples) in the folders with "spring" in their name.

Use Maven to build your project:

```shell

mvn compile

```

When running a Kalix service locally, we need to have its companion Kalix Proxy running alongside it.

To start your service locally, run:

```shell

mvn kalix:runAll

```

This command will start your Kalix service and a companion Kalix Proxy as configured in [docker-compose.yml](./docker-compose.yml) file.

With both the proxy and your service running, once you have defined endpoints they should be available at `http://localhost:9000`.

To deploy your service, install the `kalix` CLI as documented in

[Setting up a local development environment](https://docs.kalix.io/setting-up/)

and configure a Docker Registry to upload your docker image to.

You will need to update the `dockerImage` property in the `pom.xml` and refer to

[Configuring registries](https://docs.kalix.io/projects/container-registries.html)

for more information on how to make your docker image available to Kalix.

Finally, you can use the [Kalix Console](https://console.kalix.io)

to create a project and then deploy your service into the project either by using `mvn deploy kalix:deploy` which

will conveniently package, publish your docker image, and deploy your service to Kalix, or by first packaging and

publishing the docker image through `mvn deploy` and then deploying the image

through the `kalix` CLI.