ntr1x / ggcode-example-store

Online Store Example

This example demonstrates how to use GGCode Spring, Compose, and Core repositories together. Use it to bootstrap a local environment with Postgres, PGAdmin, Kafka, KafkaUI, and HaProxy, along with a multi-module Spring Boot project featuring Product Catalog, Customer Database, Customer Basket, and specialized Payments microservices.

Quick Start

Prerequisites

Step 1

You need Java 17+ and Maven 3.8.8+ to build and run the application. Make sure that your Maven points to Java 17+.

Step 1

Upload your SSH Key to a GitHub. It is usually located in ~/.ssh/id_rsa.pub on Linux.

Step 2

Add this routes to your hosts file:

127.0.0.1   api.local.example.com
127.0.0.1   swagger-ui.local.example.com
127.0.0.1   kafka-ui.local.example.com
127.0.0.1   pgadmin.local.example.com
127.0.0.1   api.local.example.com

It is usually located in /etc/hosts on Linux.

Step 3

Make sure that ports 80, 5432 and 9092 are free on your system.

Bootstraping

# Clone
$ git clone https://github.com/ntr1x/ggcode-example-store

# Go to the project root directory
$ cd ggcode-example-store

# Go to the project root directory
$ ggcode install

# Generate compose manifests
$ ggcode run @/generate-compose

# Generate spring boot applicaiton
$ ggcode run @/generate-spring

# Generate liquibase migrations
$ ggcode run @/generate-migrate

# Generate admin application
$ ggcode run @/generate-admin

Launching

Step 1

Export PROJECT_ROOT environment variable:

# Just to simplify further instructions:
$ export PROJECT_ROOT=$(pwd)

Step 2

Build back-end application:

$ cd $PROJECT_ROOT/store_backend
$ make build/assembly_web

Step 3

Build Admin UI:

$ cd $PROJECT_ROOT/store_admin
$ make build/admin_ui

Step 4

Launch containers:

$ cd $PROJECT_ROOT/store_starter
$ docker compose --profile env --profile app up -d

Step 5

Migrate database:

$ cd $PROJECT_ROOT/store_migrate
$ make migrate/changelog/liquibase_host

Step 6

Initialize keycloak installation:

# Launch one-off container to initialize keycloak
$ cd $PROJECT_ROOT/store_starter
$ docker compose run env_kcadm

Step 7

Open in your browser:

• http://admin-ui.local.example.com/
• http://swagger-ui.local.example.com/
• http://kafka-ui.local.example.com/
• http://pgadmin.local.example.com/

Futher Development

This project is a greate template for your real-world adoptions. If you want to develop your own application:

1. Move this project to your own Git repository.
2. Optionally remove the contents of the app/ directory from .gitignore file.
3. Make some modifications in action scripts (they are located in ./run directory)
4. Overwrite generated content using ggcode run command.
5. Commit & Push it to your Git repository.