[#4] Finalize backend bootstrap and docs structure by igorsatsyuk · Pull Request #116 · igorsatsyuk/distributed-audit-ledger

igorsatsyuk · 2026-05-14T16:02:03Z

Description

Completes Issue #4 by finalizing the backend multi-module bootstrap and aligning project documentation/workflow around the current stack and conventions.

Backend changes

finalized parent/module Maven setup (Spring Boot 4.x, Java 25+)
switched HTTP layer to WebFlux and aligned reactive persistence dependencies/config
introduced shared common modules content (event-model, shared-contracts)
added service skeleton entrypoints and module-level application configs
migrated package/group namespace to lt.satsyuk.distributed.audit
aligned source layout with package paths

Documentation cleanup

removed redundant root markdown files and consolidated contributor workflow docs
introduced standard CONTRIBUTING.md
updated docs cross-links and PR template
reduced duplication in docs/ by clarifying architecture/flow/deployment doc roles

Closes

Closes #4

Testing

cd backend
mvn -q test
mvn -q validate

Copilot

Pull request overview

This PR consolidates the project docs around CONTRIBUTING.md, GITHUB_ISSUES_PLAN.md, and docs/, while bootstrapping the backend Maven multi-module structure with Spring Boot service skeletons and shared contracts/events.

Changes:

Replaces old planning/index docs with a cleaner contributing and architecture documentation structure.
Adds backend parent/module POM configuration plus starter application classes and service configs.
Adds shared event/DTO models and initial database migration for the audit event store.

Reviewed changes

Copilot reviewed 40 out of 40 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`START_HERE.md`	Updates onboarding document links and next action.
`README.md`	Points quick start and contributing workflow to current docs.
`README_GITHUB_PLAN.md`	Removes superseded planning overview.
`PROJECT_SUMMARY.md`	Removes superseded summary doc.
`PRE_DEVELOPMENT_CHECKLIST.md`	Removes obsolete checklist.
`INDEX.md`	Removes obsolete index/planning doc.
`GITHUB_MANAGEMENT_GUIDE.md`	Removes workflow guide replaced by `CONTRIBUTING.md`.
`GITHUB_ISSUES_TEMPLATES.md`	Removes old ready-made issue templates.
`GITHUB_ISSUES_PLAN.md`	Marks issue #4 subtasks done and aligns backend plan with WebFlux/R2DBC.
`docs/DEPLOYMENT.md`	Converts deployment doc into a runbook map.
`docs/CQRS_FLOW.md`	Expands runtime CQRS/event flow.
`docs/ARCHITECTURE.md`	Documents canonical component boundaries and integrations.
`CONTRIBUTING.md`	Adds contributor workflow, standards, commands, and review checklist.
`backend/README.md`	Adds backend module overview, build/run instructions, env vars, and architecture diagram.
`backend/pom.xml`	Configures backend parent Maven project, modules, managed dependencies, and plugins.
`backend/common/event-model/pom.xml`	Adds event-model module dependencies.
`backend/common/event-model/src/main/java/lt/satsyuk/distributed/audit/event/AuditEvent.java`	Adds base audit event model.
`backend/common/event-model/src/main/java/lt/satsyuk/distributed/audit/event/EventType.java`	Adds domain event type enum.
`backend/common/event-model/src/main/java/lt/satsyuk/distributed/audit/event/UserLoggedInEvent.java`	Adds user-login domain event factory/model.
`backend/common/event-model/src/test/java/lt/satsyuk/distributed/audit/event/UserLoggedInEventTest.java`	Adds placeholder test file.
`backend/common/shared-contracts/pom.xml`	Adds shared contracts module dependencies.
`backend/common/shared-contracts/src/main/java/lt/satsyuk/distributed/audit/contracts/command/UserLoginCommand.java`	Adds command DTO with validation.
`backend/common/shared-contracts/src/main/java/lt/satsyuk/distributed/audit/contracts/dto/AuditEventDto.java`	Adds read-model audit event DTO.
`backend/common/shared-contracts/src/main/java/lt/satsyuk/distributed/audit/contracts/dto/CommandResponse.java`	Adds generic command response DTO.
`backend/command-service/pom.xml`	Adds command-service dependencies and boot plugin.
`backend/command-service/src/main/java/lt/satsyuk/distributed/audit/command/CommandServiceApplication.java`	Adds command-service Spring Boot entry point.
`backend/command-service/src/main/resources/application.yml`	Adds command-service port, Kafka, actuator, and logging config.
`backend/command-service/src/test/java/lt/satsyuk/distributed/audit/command/CommandServiceIntegrationTest.java`	Adds embedded-Kafka integration-test meta-annotation.
`backend/event-store-service/pom.xml`	Adds event-store dependencies for WebFlux, R2DBC, Kafka, Flyway, and tests.
`backend/event-store-service/src/main/java/lt/satsyuk/distributed/audit/eventstore/EventStoreServiceApplication.java`	Adds event-store Spring Boot entry point.
`backend/event-store-service/src/main/resources/application.yml`	Adds event-store DB, Flyway, Kafka, actuator, and logging config.
`backend/event-store-service/src/main/resources/db/migration/V1__init_audit_schema.sql`	Adds Flyway migration for `audit.events`.
`backend/query-service/pom.xml`	Adds query-service dependencies for WebFlux/R2DBC/contracts.
`backend/query-service/src/main/java/lt/satsyuk/distributed/audit/query/QueryServiceApplication.java`	Adds query-service Spring Boot entry point.
`backend/query-service/src/main/resources/application.yml`	Adds query-service DB, actuator, and logging config.
`backend/audit-writer-service/pom.xml`	Adds audit-writer dependencies for Kafka/Web3j.
`backend/audit-writer-service/src/main/java/lt/satsyuk/distributed/audit/auditwriter/AuditWriterServiceApplication.java`	Adds audit-writer Spring Boot entry point.
`backend/audit-writer-service/src/main/resources/application.yml`	Adds audit-writer Kafka, Web3j, actuator, and logging config.
`AGENTS.md`	Updates agent guidance to point at current docs.
`.github/pull_request_template.md`	Expands PR template checklist and testing sections.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 40 out of 41 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 40 out of 41 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 40 out of 41 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 40 out of 41 changed files in this pull request and generated 3 comments.

Copilot

Pull request overview

Copilot reviewed 40 out of 41 changed files in this pull request and generated 3 comments.

…ands

Copilot

Pull request overview

Copilot reviewed 41 out of 42 changed files in this pull request and generated 3 comments.

Copilot

Pull request overview

Copilot reviewed 41 out of 42 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 41 out of 42 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 42 out of 43 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 42 out of 43 changed files in this pull request and generated no new comments.

[#4] Finalize backend bootstrap and docs structure

c0dcdb0

Copilot AI review requested due to automatic review settings May 14, 2026 16:02

Copilot started reviewing on behalf of igorsatsyuk May 14, 2026 16:02 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Comment thread backend/event-store-service/src/main/resources/application.yml Outdated

Comment thread backend/query-service/src/main/resources/application.yml Outdated

Comment thread backend/README.md Outdated

[#4] Align DB defaults with deploy stack and ignore pycache

b590337

igorsatsyuk requested a review from Copilot May 14, 2026 16:09

Copilot started reviewing on behalf of igorsatsyuk May 14, 2026 16:09 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Comment thread backend/audit-writer-service/pom.xml

Comment thread backend/common/event-model/src/main/java/lt/satsyuk/distributed/audit/event/AuditEvent.java Outdated

[#4] Fix review notes for actuator and eventType polymorphism

b3cdbaa

igorsatsyuk requested a review from Copilot May 14, 2026 16:14

Copilot started reviewing on behalf of igorsatsyuk May 14, 2026 16:15 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Comment thread backend/README.md Outdated

[#4] Mark backend flow diagram as planned

d405532

igorsatsyuk requested a review from Copilot May 14, 2026 16:19

Copilot started reviewing on behalf of igorsatsyuk May 14, 2026 16:20 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Comment thread ...mmon/event-model/src/test/java/lt/satsyuk/distributed/audit/event/UserLoggedInEventTest.java

[#4] Add event-model unit tests for UserLoggedInEvent

c181c44

igorsatsyuk requested a review from Copilot May 14, 2026 16:25

Copilot started reviewing on behalf of igorsatsyuk May 14, 2026 16:25 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Comment thread docs/DEPLOYMENT.md Outdated

Comment thread GITHUB_ISSUES_PLAN.md Outdated

Comment thread GITHUB_ISSUES_PLAN.md Outdated

[#4] Align roadmap schema and deployment order with stack

fb32cb6

igorsatsyuk requested a review from Copilot May 14, 2026 16:35

Copilot started reviewing on behalf of igorsatsyuk May 14, 2026 16:35 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Comment thread backend/README.md Outdated

Comment thread CONTRIBUTING.md Outdated

Comment thread backend/event-store-service/src/main/resources/db/migration/V1__init_audit_schema.sql

[#4] Address PR review threads: event_id column, mvn reactor run comm…

ff45f0f

…ands

igorsatsyuk requested a review from Copilot May 14, 2026 16:59

Copilot started reviewing on behalf of igorsatsyuk May 14, 2026 17:00 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

Comment thread GITHUB_ISSUES_PLAN.md Outdated

Comment thread deploy/init-db.sql Outdated

Comment thread backend/event-store-service/src/main/resources/db/migration/V1__init_audit_schema.sql Outdated

igorsatsyuk added 2 commits May 14, 2026 20:08

[#4] Ignore IntelliJ out directory

1c07c9d

[#4] Align event schema docs and indexes

d4f9b9a

igorsatsyuk requested a review from Copilot May 14, 2026 17:13

Copilot started reviewing on behalf of igorsatsyuk May 14, 2026 17:14 View session

Copilot AI reviewed May 14, 2026

View reviewed changes

igorsatsyuk requested a review from Copilot May 15, 2026 07:36

Copilot started reviewing on behalf of igorsatsyuk May 15, 2026 07:37 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

Comment thread backend/event-store-service/src/main/resources/db/migration/V1__init_audit_schema.sql

[#4] Add migration path for legacy event_id

2538ff8

igorsatsyuk requested a review from Copilot May 15, 2026 07:59

Copilot started reviewing on behalf of igorsatsyuk May 15, 2026 07:59 View session

igorsatsyuk requested review from Copilot and removed request for Copilot May 15, 2026 08:08

Copilot started reviewing on behalf of igorsatsyuk May 15, 2026 08:08 View session

Copilot stopped reviewing on behalf of igorsatsyuk due to an error May 15, 2026 08:13
Workflow completed but conclusion is not available. This may indicate rate limiting or API issues.

Copilot AI reviewed May 15, 2026

View reviewed changes

Comment thread ...event-store-service/src/main/resources/db/migration/V2__add_event_id_for_existing_tables.sql

[#4] Avoid duplicate unique constraint for event_id

3d5117f

igorsatsyuk requested a review from Copilot May 15, 2026 08:34

Copilot started reviewing on behalf of igorsatsyuk May 15, 2026 08:34 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

igorsatsyuk self-assigned this May 15, 2026

igorsatsyuk merged commit 7baa576 into main May 15, 2026
1 check passed

This was linked to issues May 15, 2026

[SUBTASK] #4.1 - Создать parent pom.xml с зависимостями #32

Closed

[SUBTASK] #4.2 - Создать common модули #33

Closed

[SUBTASK] #4.3 - Создать скелеты сервисов #34

Closed

igorsatsyuk deleted the feature/#4-backend-bootstrap-cleanup branch June 5, 2026 05:55

Conversation

igorsatsyuk commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Backend changes

Documentation cleanup

Closes

Related

Testing

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

igorsatsyuk commented May 14, 2026 •

edited

Loading