How hamdielzard/wordeo works
Main Components
• Client (Frontend)
• Located in the “client” directory.
• Built with React (entry point at client/src/index.jsx) and includes multiple components (e.g., Game components, Store components, Pages for Account, Game, Leaderboard, etc.), styles, and tests.
• The client is containerized (client/Dockerfile) and runs on port 3000 (as indicated in the README instructions).
• Server (Backend)
• Found in the “server” directory.
• A Node.js with Express service that implements several controllers (auth, game, score, store, user, word) and corresponding routes.
• Uses an MVC-like architecture with controllers, routes, and models (e.g., user.js, scores.js, store.js, words.js).
• Containerized using its own Dockerfile and managed via docker-compose.
• Database
• Although no explicit database configuration files are present, the README mentions MongoDB as part of the MERN stack. Represent MongoDB as a separate component that the server interacts with, mainly via the models.
• Additional Components
• Docker & docker-compose: Represent the orchestration container layer.
• CI/CD Pipelines: The .github/workflows files (for SonarQube, Docker builds, etc.) should be noted as supporting elements that ensure code quality and consistent builds.
• Load Testing: The “wordeo_load_test” folder contains test plans and CSV data that can be referenced as part of performance testing.
Relationships and Interactions
• Inside the backend, show the flow from “routes” → “controllers” → “models” for handling requests.
• Server to the MongoDB instance to indicate database operations (e.g., registration, scores, game state, etc.).
• External services (such as CI/CD workflows) that build, test, and deploy the containers via Docker-compose.
Architectural Patterns and Technologies
• Separation between the frontend (React-based, Single Page Application) and backend (Node/Express with MVC structure).
• That backend services are organized via RESTful API endpoints (auth, game, scores, store, user, words).
• Mention that Docker and docker-compose are used to containerize and orchestrate the components.
• MERN stack as the central technology, showing that MongoDB serves as the persistent storage.