Darminha detonando na ia

[LeandroParisi]

Summary

This PR introduces centralized configuration management and comprehensive documentation for the Games API.

Changes

✨ New Features

• Centralized Configuration System: Created AppConfig with environment variable validation
  • Validates required variables (MONGODB, BROKER_URL) at startup
  • Provides type-safe access to all configuration values
  • Includes helper functions for environment checks (isProduction(), isDevelopment(), isTest())

📝 Documentation

• Comprehensive README: Added detailed documentation covering:

  • Project overview and features
  • API endpoints with examples
  • WebSocket integration details
  • Installation and configuration guides
  • Docker setup instructions
  • Project structure

• Environment Template: Created env.example with all required and optional variables

🔧 Refactoring

• Replaced all process.env usage with AppConfig throughout the codebase:

  • index.ts: Uses AppConfig.server.port
  • mongodb.ts: Uses AppConfig.database.mongodb.uri
  • websocket.ts: Uses AppConfig.websocket.brokerUrl

• TypeScript Configuration: Added @config path alias for easier imports

Benefits

• ✅ Better Developer Experience: Type-safe configuration with autocomplete
• ✅ Early Error Detection: Missing required env vars are caught at startup
• ✅ Improved Maintainability: Single source of truth for configuration
• ✅ Better Documentation: Comprehensive README for onboarding

Breaking Changes

⚠️ None - This is a refactoring that maintains backward compatibility. However, ensure your .env file includes the required variables (MONGODB and BROKER_URL).

Testing

• Configuration validation tested with missing required variables
• All existing functionality verified with new configuration system
• TypeScript compilation successful

[pedrodarma]

=]