How openzeppelin/contracts-wizard works
Begin by identifying and labeling the major components
• Code Generation Core: Found in packages/core. Notice that within this folder there are submodules for different languages (solidity, cairo, cairo_alpha, stellar, stylus). Each is responsible for generating and testing contract code for its respective language.
• CI/CD and Deployment: Include the configuration files (GitHub workflows in .github/workflows, Netlify configuration, etc.) that manage deployments, testing, and builds.
Architectural patterns and design principles
• Modular Design: The core logic is split into multiple language-specific packages. Represent this using containers or sections clearly segregating “solidity”, “cairo”, “cairo_alpha”, “stellar”, and “stylus”.
• Separation of Concerns: The UI (presentation layer) is separate from the logic (the code generation core). Additionally, testing and configuration are kept in their respective directories.
• Extensibility: Include annotations to note that new languages or components might be added by following the existing patterns.
• CI/CD Integration: Note that configuration files (workflows, scripts, Netlify config) automate testing, compiling, and deploying.
• Svelte for the UI.
• NodeJS/JavaScript/TypeScript as seen from scripts, tests, and configuration files.
• AVA testing framework (as indicated by ava.config.js).
• GitHub Actions (GitHub workflows) and Netlify for deployment.
• For each core package: language-specific tooling (for example, Hardhat configuration in solidity, Scarb in Cairo, etc.).