How abeltruong/abel-portfolio works
Main Components
• Frontend Markup: The core HTML files (e.g., index.html, google274554f74ea14d5d.html) form the basic structure of the site.
• Style Layer:
• SCSS Source Files: Located in assets/sass, these files (like _nav_bar.scss, _responsive.scss, etc.) are compiled into CSS.
• Compiled CSS: The output CSS files (assets/css/app.css) are used by the HTML.
• JavaScript Functionality:
• Assets in assets/js and js directory form the site’s interactive behaviors (blog handling, modals, actions).
• Mock Data & Additional Assets:
• The mocks directory provides sample data (e.g., blogs.json and abel_CV.pdf) often used for testing or demonstration.
• Images and other static assets are stored in assets/images.
• Build & Tooling:
• package.json, webpack.config.js, and associated configuration files indicate that a build process (such as compiling SCSS, bundling JS) is part of the project.
• Deployment & Configuration:
• Files like CNAME and configuration files for GitHub (.github) and Prettier indicate deployment details and coding styles.
Out Component Relationships
• The HTML pages link to the CSS (compiled from SCSS) and include JavaScript files.
• The SCSS files (assets/sass) are processed—likely via a bundler and the “yarn compile_style” script—to generate the main CSS (assets/css/app.css).
• JavaScript components (from both assets/js and js directories) attach dynamic behaviors (e.g., modal pop-ups, blog interactions) to the DOM.
• The build tools (webpack.config.js) and package.json are responsible for compiling and optimizing the code before deployment.
• The mocks folder can be represented as sample data sources; these are not served directly but are useful during development/testing.
• External integrations include Google Search Console and schema markup for blog and homepage, which can be shown as connections from the website to online services.
Architectural Patterns and Design Principles
• Separation of Concerns: Presentation (HTML), styling (SCSS/CSS), and behavior (JavaScript) are clearly separated.
• Modular & Maintainable Code: The use of separate SCSS files for different site sections (e.g., _blog.scss, _nav_bar.scss) suggests modularity, making the CSS easier to maintain.
• Static Site Architecture: Since the project is a static site, all resources are precompiled and then served via a static hosting solution.
• Build Pipeline: The integration of Webpack and Yarn scripts points to an automated build process for asset compilation and bundling.
Be Detailed but Focused
• Essential details as mentioned without overcomplicating: if needed, label additional paths like the schema markup injection, which is executed by JavaScript after reading meta tags (as shown in the example code from the README).
• Clearly demarcate development-time artifacts (like mocks and configuration files) versus the production build.