148 documentacion

[JonayKB]

No description provided.

[Copilot]

Pull Request Overview

This PR updates the project documentation and improves the comment repository query for the application. Key changes include:

• A comprehensive update to README.md with added sections for usage, Docker setup, and endpoints.
• An updated custom Neo4j query in the comment repository to retrieve comments by post ID.

Reviewed Changes

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

File	Description
README.md	Expanded documentation with improved navigation and detailed usage instructions, including Docker and endpoint usage.
API/src/main/java/es/iespuertodelacruz/routinefights/comment/infrastructure/adapters/secondary/repositories/ICommentEntityRepository.java	Updated repository method to include a custom query for fetching comments by post ID using Neo4j.

Comments suppressed due to low confidence (1)

API/src/main/java/es/iespuertodelacruz/routinefights/comment/infrastructure/adapters/secondary/repositories/ICommentEntityRepository.java:14

• Ensure that using elementId(p) for matching is optimal for your dataset; if this query is executed frequently, consider verifying that appropriate indexes or constraints are in place to maintain performance.

@Query("MATCH (u:User)-[r:Commented]->(c:Comment)-[r2:On]->(p:Post) WHERE elementId(p) = $postID RETURN c,r2,p,u,r")

[Copilot]

[nitpick] Consider clarifying this instruction to ensure readers understand whether they should set up a local Neo4j instance or use an external client; a more descriptive phrasing would improve usability.