How bypasslane/angular-virtual-pete works
Your Main Components
• Core Library (src folder):
– Components include virtualPete.js, virtualPeteContainer.js, virtualPeteRepeat.js, as well as supporting utilities (service.js, util.js, virtualPete.scss).
– This is the heart of the virtual repeat functionality.
• Example Application (app folder):
– Contains HTML (index.html), and Angular controllers/views (e.g., pages/home/home.controller.js and pages/pagination/pagination.controller.js).
– It serves as the demo to illustrate how the library is used within an Angular app.
• Build Pipeline (gulp folder and associated config/build scripts):
– The gulp scripts (cssBuild.js, indexBuild.js, jsBuild.js, config.js) orchestrate the building process, converting the src files (JavaScript and SCSS) into the distributable files.
• Distribution Artifacts (dist folder):
– Compiled output such as angular-virtual-pete.js and angular-virtual-pete.css, which are ready for integration into other Angular projects.
Processes and Relationships
• The Build Process:
– This shows how raw source code is transformed into final distributable assets.
• Demo Application Usage:
– Show that the “Example Application” loads and utilizes the distributable files (from the dist folder) along with Angular controllers and views.
• Integration Points:
– You may also include a block for Dependency Management (represented by package.json and bower.json) since these files indicate how external dependencies are managed and integrated.
Architectural Patterns and Technologies
• Use clear labels (e.g., “Core Library”, “Build Pipeline”, “Example App”, “Distribution Output”).
– Rectangles for code modules and libraries.
• Mention that the design leverages standard Angular practices (controllers, templates, and directives) and uses Gulp as the task runner for building the assets.