namastack-outbox

(β˜… 372)

Outbox Implementation for Spring Boot

  • .editorconfig
  • .gitignore
  • build.gradle.kts
  • codecov.yml
  • CONTRIBUTING.md
  • detekt.yml
  • gradle.properties
  • gradlew
  • gradlew.bat
  • LICENSE
  • README.md
  • SECURITY.md
  • settings.gradle.kts
  • THIRD_PARTY_LICENSES.md

# Installation Guide

1. Get the code
git clone https://github.com/namastack/namastack-outbox

Downloads the entire project code from GitHub to your computer.

cd namastack-outbox

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f namastack-outbox-examples/namastack-outbox-example-kafka-java/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd namastack-outbox-docs

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation