Feature/es 73 improve readme file and create a licence#58
Merged
raouf-b-dev merged 15 commits intomasterfrom Dec 29, 2025
Merged
Conversation
…mentation. This update improves the API documentation for various endpoints in the Orders and Products modules, adding descriptions and response details for better clarity and usability. It also introduces a new OrderStatus enum for improved type safety in order responses.
…rovements. Added sections on advanced engineering features, including strict idempotency and event-driven compensation patterns. Updated technology stack details and included a recruiter’s guide highlighting senior-level engineering skills.
Updated testing excellence description to specify unit test coverage only.
Updated README to include BullMQ and Jest badges, and expanded testing coverage description.
…map section. Changed the project description to reflect an enterprise-level API and included planned features for core functionality, engineering improvements, and ecosystem development.
… of https://github.com/PrimeRaouf/ecommerce-store-api into feature/ES-73-improve-readme-file-and-create-a-licence
…information. Updated the directory layout to include a core module for shared concerns and enhanced feature modules with specific subdirectories for domain, application, infrastructure, and testing. Changed licensing details to reflect the MIT License, allowing broader usage and distribution.
…unity guidelines and contribution process
… process Created a bug report template to streamline issue reporting and a feature request template to facilitate suggestions for new features. These templates aim to enhance clarity and consistency in contributions.
…ta with a detailed description, updated author information, changed license to MIT, and added repository and bugs URLs. Included relevant keywords for better discoverability.
…hitecture overview, and hybrid payment orchestration. Added links to contributing guidelines and system architecture documentation, along with a mermaid diagram for visual representation. This update aims to provide clearer insights into the project's goals and technical design.
…re-api. This new file outlines the system's high-level architecture, modular design using NestJS, and key patterns such as Domain-Driven Design and SAGA flows. It includes mermaid diagrams for visual representation of the architecture, module structure, checkout sequences, and payment event handling, enhancing understanding of the system's design and functionality.
…ponents and their interactions. Enhanced the description of hybrid payment orchestration capabilities and updated links for better navigation to architecture documentation.
…ty of the flow chart
raouf-b-dev
deleted the
feature/ES-73-improve-readme-file-and-create-a-licence
branch
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.
No description provided.