Skip to content

docs: add README for the One.Stepper reference application - #3

Open
veliodanev wants to merge 1 commit into
masterfrom
docs/add-readme
Open

veliodanev wants to merge 1 commit into
masterfrom
docs/add-readme

Conversation

@veliodanev

Copy link
Copy Markdown

Summary

Adds a top-level README.md for the One.Stepper reference application.

The repository previously had no README; the only documentation was the internal Inception_sampleApp.md. This PR adds a public-facing README that:

  • Explains what the project is and why the step-tracking domain was chosen.
  • Describes the event-driven architecture (commands → aggregates → events) and the aggregate design rationale.
  • Documents the key types (DailyActivity, DailyActivityId, DailyActivityState, DailyActivityAppService, and the command/events).
  • Lists the production technology stack (RabbitMQ, Cassandra, Redis, Consul).
  • Shows the project structure and provides build instructions.
  • Links to the Apache 2.0 license.

Verification

  • dotnet build One.Stepper.slnx succeeds with 0 warnings / 0 errors.

Created by an AI agent (OpenHands) on behalf of the user.

Documents the project overview, business domain, event-driven
architecture, key types, technology stack, project structure, and
build instructions.

Co-authored-by: openhands <openhands@all-hands.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants