docs: 📝 update README with comprehensive API documentation and s…

[Mraimundo]

User description

…etup guide

---

PR Type

Documentation

---

Description

• Replaced minimal requirements list with comprehensive API documentation

• Added detailed setup guide with environment configuration steps

• Included complete endpoint reference with curl examples

• Added sections for authentication, testing, CI/CD, and troubleshooting

---

Diagram Walkthrough

flowchart LR
  A["Basic Requirements List"] -->|Expand| B["Project Overview"]
  B --> C["Setup Instructions"]
  B --> D["API Endpoints"]
  B --> E["Authentication Guide"]
  B --> F["Testing & CI/CD"]
  B --> G["Troubleshooting"]

Loading

File Walkthrough

Relevant files

Documentation

README.md Complete README overhaul with API documentation                    README.md Replaced minimal functional/business requirements with comprehensive project documentation Added detailed setup guide covering Node.js, Docker, environment variables, and Prisma migrations Documented all major API endpoints with request/response examples and curl commands Added sections for authentication flow, authorization roles, testing procedures, and troubleshooting Included technology stack, prerequisites, npm scripts, and CI/CD information +218/-32

---

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided - [ ] Create ticket/issue <!-- /create_ticket --create_ticket=true --> </details></td></tr>
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
⚪	No custom compliance provided Follow the guide to enable custom compliance check.

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Security	Strengthen security with a unique secret Add a security warning to the documentation, advising developers to replace the default weak JWT_SECRET with a strong, random key in production. README.md [61-65] Variáveis disponíveis (padrão do exemplo): - NODE_ENV=dev -- JWT_SECRET=supersecretkey +- JWT_SECRET=supersecretkey # ATENÇÃO: Use uma chave forte e aleatória em produção. - DATABASE_URL=postgres://docker:docker@localhost:5432/gympassapi?schema=public - PORT=3333 Apply / Chat Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a weak default JWT_SECRET and recommends adding a security warning, which is a crucial best practice for production deployments.	Medium
Possible issue	Correct HTTP status codes in documentation Correct the documented HTTP status code for the GET /gyms/search and GET /gyms/nearby endpoints from 201 OK to the standard 200 OK. README.md [116-120] Academias (requer JWT) - GET /gyms/search?q=academia&page=1 - Busca por nome - - 201 OK { gyms: Gym[] } + - 200 OK { gyms: Gym[] } - GET /gyms/nearby?latitude=-23.5&longitude=-46.6 - Próximas - - 201 OK { gyms: Gym[] } + - 200 OK { gyms: Gym[] } Apply / Chat Suggestion importance[1-10]: 5 __ Why: The suggestion correctly identifies and fixes an incorrect HTTP status code (201 OK instead of 200 OK) in the API documentation, improving its accuracy for developers.	Low
More