How cesaramirezfr/codechallenges works
Main Components
• Code Challenge Modules: There are three major folders:
• Challenges – General code challenges.
• Dojo – Daily katas (algorithm practice problems).
• LeetCode – Exercises from LeetCode, further organized into study plans (e.g., TopInterview150).
• Build & Configuration: Key project configuration files such as package.json, tsconfig.json, bun.lock, and .gitignore should be represented as supporting components that govern dependency management, TypeScript configuration, and build processes.
• Entry Point: The index.ts file can be indicated as the main entry point for the application (if used typically in execution), even if the primary activity is running tests.
Relationships and Interactions
• That each category (Challenges, Dojo, LeetCode) is a collection of algorithm modules, each with its implementation and corresponding test cases.
Architectural Patterns and Design Principles
• Test-Driven Approach: Emphasize the connection between the code for the challenges (logic) and its tests, demonstrating unit testing as a core part of the project.
• Separation of Concerns: Clearly distinguish between different types of challenges (i.e., the main challenge implementations vs. their tests) and also between the problem domains (general challenges, katas, and LeetCode exercises).
Relevant Technologies and Frameworks
• TypeScript: Highlight that the project primarily uses TypeScript (indicated by tsconfig.json).
• Bun: Represent the Bun runtime and toolchain for dependency management and test running (as seen with bun.lock and bun test instructions).
• Standard Node.js project structure: Although this is not a full-stack app, note that many of the best practices such as clear directory separation, configuration management, and automated tests are applied.
Specific Elements
• Use clear labels for each folder: Challenges, Dojo, LeetCode.
• Rectangles for code modules.
• Bun Test Runner and highlight its relationship with the source code files.
• Important dependencies (e.g., TypeScript and Bun) around the configuration files to demonstrate how they influence the build and test process.
Recap
• Under each category, you could optionally break down further into individual challenges or modules with a clear test component.