Skip to content
optivemPublic

About

Optivem Shop

Resources

Contributing

Security policy

Stars

12 stars

Watchers

0 watching

Forks

Latest commit

 

History

4,856 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MyShop

Latest release

A catalog of project templates organized by two independent dimensions: system (the application) and system-test (the test harness). Each template is self-contained and copy-paste-ready.

Interviewing or reviewing this repo? Start with the guided tour.

Verification

meta-prerelease-stage meta-release-stage

meta-prerelease-stage — runs the prerelease pipeline (local → commit → Docker Compose acceptance gates) across all languages and architectures; tags the SHA as meta-v<VERSION>-rc.<N> on success. Does not release to production. Flavor RCs come only from the manually dispatched cloud acceptance stages (see Acceptance Stage). meta-release-stage — takes a meta-rc tag, orchestrates production releases across all 6 flavor prod-stages, tags meta-v<VERSION>, and bumps the root meta VERSION via bump-patch-version-meta. Each flavor's prod-stage bumps its own per-system VERSION (system/<arch>/<lang>/VERSION) post-release. This is the single canonical release path.

Cleanup

cleanup

Daily cleanup (23:00 UTC) of superseded deployments, prerelease git tags, GitHub releases, and Docker image tags.

Test Users

Local Docker, acceptance and QA sign in through Keycloak, which is seeded from docker/keycloak/shop-realm.json with these demo test accounts (not real credentials):

Username Password Role
customer1 customer1-test-password CUSTOMER
customer2 customer2-test-password CUSTOMER
admin1 admin1-test-password ADMIN

If you change them, change them in shop-realm.json. The system tests sign in with these same users.

Production (https://shop.optivem.com, realm shop-prod) has none of these users: prod-realm.jq strips them and prod-realm-check.jq fails the image build if any come back. Self-registration is off, so production accounts are created by hand in the Keycloak admin console.

Architecture

Monolith

graph LR
    User -->|UI / API| Monolith
    Monolith -->|REST| ERP
    Monolith -->|REST| Clock
Loading

Multitier

graph LR
    User -->|UI| Frontend
    User -->|API| Backend
    Frontend -->|REST| Backend
    Backend -->|REST| ERP
    Backend -->|REST| Clock
Loading

Use Cases

All use cases, with their narratives, business rules and acceptance criteria, are indexed in Use Cases.

graph LR
    Customer([Customer])
    ERP([ERP])
    Clock([Clock])

    Customer --> PlaceOrder(Place Order)
    Customer --> ViewOrder(View Order)
    Customer --> BrowseOrders(Browse Orders)
    Customer --> CancelOrder(Cancel Order)

    PlaceOrder --> ERP
    PlaceOrder --> Clock
Loading

UX

The four UIs share one storefront UX spec: Storefront UX. It covers routes, page wireframes, visual tokens, and the selector contract the system-test UI drivers depend on.

System Templates

Pick based on your architecture and language:

Monolith

Language Directory Framework Port SonarCloud
Java system/monolith/java/ Spring Boot + Thymeleaf (SSR) 8080 shop-monolith-java
.NET system/monolith/dotnet/ ASP.NET Core Razor Pages 8080 shop-monolith-dotnet
TypeScript system/monolith/typescript/ Next.js (SSR) 3000 shop-monolith-typescript

Multitier

Frontend

Language Directory Framework Port SonarCloud
TypeScript system/multitier/frontend-react/ React + Nginx 8080 shop-multitier-frontend-react

Backend

Language Directory Framework Port SonarCloud
Java system/multitier/backend-java/ Spring Boot API 8081 shop-multitier-backend-java
.NET system/multitier/backend-dotnet/ ASP.NET Core API 8081 shop-multitier-backend-dotnet
TypeScript system/multitier/backend-typescript/ NestJS API 8081 shop-multitier-backend-typescript

System-Test Templates

Pick based on your preferred test language (independent of system language):

Language Directory Framework
Java system-test/java/ JUnit 5 + Playwright
.NET system-test/dotnet/ xUnit + Playwright
TypeScript system-test/typescript/ Jest + Playwright

Each system-test includes docker-compose files for both architectures in local and pipeline variants (e.g. docker-compose.local.monolith.real.yml, docker-compose.pipeline.multitier.stub.yml). Remove the files for the architecture you don't need.

CI/CD Pipelines

The .github/workflows/ directory contains runnable pipelines for all 6 matched-language combinations (system + system-test):

Monolith Java

monolith-commit-stage acceptance-stage acceptance-stage-docker-compose acceptance-stage-docker-compose-legacy qa-stage qa-signoff prod-stage

Monolith .NET

monolith-commit-stage acceptance-stage acceptance-stage-docker-compose acceptance-stage-docker-compose-legacy qa-stage qa-signoff prod-stage

Monolith TypeScript

monolith-commit-stage acceptance-stage acceptance-stage-docker-compose acceptance-stage-docker-compose-legacy qa-stage qa-signoff prod-stage

Multitier Java

backend-commit-stage frontend-commit-stage acceptance-stage acceptance-stage-docker-compose acceptance-stage-docker-compose-legacy qa-stage qa-signoff prod-stage

Multitier .NET

backend-commit-stage frontend-commit-stage acceptance-stage acceptance-stage-docker-compose acceptance-stage-docker-compose-legacy qa-stage qa-signoff prod-stage

Multitier TypeScript

backend-commit-stage frontend-commit-stage acceptance-stage acceptance-stage-docker-compose acceptance-stage-docker-compose-legacy qa-stage qa-signoff prod-stage

  • Commit stages trigger automatically on push via path filters
  • Docker Compose acceptance gates (acceptance-stage-docker-compose, -legacy) run in every prerelease pipeline run, on the GitHub runner. They are free and tag nothing
  • Cloud acceptance stage (acceptance-stage, Cloud Run) is manual; run it on a commit that passed both gates. It is the only workflow that creates release candidates
  • QA, QA sign-off and production stages are manual and deploy to Cloud Run; each has a commented-out Docker Compose alternative, which is only a zero-cost stand-in

Details: Commit Stage, Acceptance Stage (including why legacy is a separate, deletable workflow), QA and Production Stages, the Environments (acceptance, E2E, QA, production) and their URLs, the cloud setup and cost model, the opt-in edge rate limiting (login limits are Keycloak's brute-force detection), and the operations runbooks: deploy, rollback, DB restore, dependency outage, SLOs and alerts.

About

Optivem Shop

Resources

Contributing

Security policy

Stars

12 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages