How janis-commerce/ui-native works
Main Components Identification
• Core UI Library:
• The core source code lives in the “src” directory. It holds a structured component hierarchy with “atoms”, “molecules”, and “organisms”.
• Components include basic elements like BaseButton, BaseInput, etc., along with more composite elements (e.g., Avatar, Button, Carousel).
• Storybook:
• The “storybook” directory along with the “.storybook” configuration represents the demo, testing, and development environment for the UI components.
• Platform-Specific Configurations:
• The “android” and “ios” directories contain native project configuration files required for integrating these UI components with mobile projects.
• Build, Linting, and CI/CD Tools:
• Configuration for ESLint, Prettier, Babel, and Husky (git hooks) are included.
• GitHub workflows under “.github/workflows” (such as build-status, coverage-status, npm-publish, publish-docs) show the CI/CD pipeline used for building, testing, publishing, and documentation.
• Additional Configurations:
• Files like “tsconfig.json”, “babel.config.js” and other tool-specific config files indicate the build and type-checking process.
• External Dependencies and Installation Requirements:
• The README highlights required dependency versions of React and React Native. It also provides instructions for additional native dependencies (e.g., react-native-reanimated) and configuration in “android/app/build.gradle”.
Key Architectural Patterns & Design Principles
• Component-Based Architecture:
• Separation of concerns (atoms, molecules, and organisms) which adheres to the principles of reusability and modularity.
• Build & Deployment Pipeline:
• How build scripts, linting, and GitHub actions integrate into the project’s lifecycle.
• Platform Abstraction:
• How native configurations for Android and iOS are kept separate while still interacting with the common UI library.
Detailed Steps for the Principal Software Engineer
• Create additional branch nodes for Storybook (demo/testing) and for CI/CD/build tools, indicating the use of GitHub workflows and various configuration files.
• External dependencies and note installation/configuration requirements as described in the README.