Improve README with complete architecture, setup instructions#8
Open
Jerry-145 wants to merge 1 commit intokeploy:mainfrom
Open
Improve README with complete architecture, setup instructions#8Jerry-145 wants to merge 1 commit intokeploy:mainfrom
Jerry-145 wants to merge 1 commit intokeploy:mainfrom
Conversation
…sting documentation The previous README lacked clarity around project structure, service responsibilities, infrastructure setup, and testing workflows. This update introduces a fully structured README that improves onboarding for new contributors and simplifies understanding of how services interact. Key Improvements 1. Architecture Clarity Added a structured overview of all services. Documented infrastructure components including MySQL, Docker Compose, and LocalStack SQS. Added reference to architecture documentation. 2. Project Structure Provided a complete directory tree. Clearly separated services and infrastructure folders. Documented migrations, testing folders, and coverage files. 3. Setup Instructions Added Docker Compose commands for: Starting services Viewing logs Stopping services 4. Service Responsibilities Detailed responsibilities added for: API Gateway Order Service Product Service User Service Including order lifecycle and idempotency handling. 5. Database Documentation Explained migration flow. Clarified DB ownership per service. 6. Messaging Flow Documented LocalStack SQS usage. Added queue setup script references. 7. Testing Documentation Documented Keploy usage. Added explanation of AI-generated tests (test1.yaml → test36.yaml). Included coverage of test scenarios: Order lifecycle Product management User validation Gateway routing Edge cases 8. Contribution Workflow Added contributor steps. Clarified development workflow.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR enhances the project documentation by restructuring and expanding the README.md to provide clearer guidance for contributors and users. The updated README now includes a well-organized architecture overview, project structure, service responsibilities, setup instructions, database migration details, messaging workflow, API documentation references, and testing details using Keploy.
Team T 161
Issue Closed #9