How geoblink/design-system works
Project type and purpose
• This is an open-source Vue.js Design System library. It provides:
• UI components (buttons, alerts, charts, tokens, layouts, etc.)
• Vue directives, mixins and utilities
• A documentation site built with VuePress
• Build scripts, templates and CI configuration for publishing
File structure
• Top-level artifacts
• package.json, LICENSE, README.md, CHANGELOG.md
• Build and config folders: build/, config/, .travis.yml, .npmignore, .babelrc, webpack.*.conf.js
• Templates and scaffolding: _templates/, .hygen.js
• Source code: src/ (elements/, directives/, mixins/, utils/, styles/, tokens/, templates/)
• Documentation site: .vuepress/ + docs/
• Testing: test/unit/ (Jest + Vue Test Utils)
• Patterns
• Modular component crates under src/elements
• Centralized tokens under src/tokens feeding SCSS variables
• Build pipeline: Webpack + Babel → dist/ system.css, .scss, JS modules
• Documentation auto-generated from component examples using VuePress
README
• Confirms library is installed via NPM/Yarn, then registered with Vue.use
• Shows how to import CSS/SCSS and use components in a Vue app
• Points to live docs on design-system.geoblink.com
Main components and their interactions
• Source components
• Tokens (YAML → SCSS variables, maps)
• Styles (SCSS modules per element, utilities)
• Vue components (src/elements/Geo*)
• Directives, mixins, utilities (src/directives, src/mixins, src/utils)
• Templates (for scaffolding new components)
• Build system
• Webpack configurations (build/webpack.*.conf.js) compile JS/SCSS → dist/
• Babel and PostCSS transform code for distribution
• Hygen templates generate new component boilerplate
• Documentation site
• VuePress (.vuepress/) reads .md examples under src/elements/***.examples.md
• Generates interactive style guide and API docs
• Testing
• Jest runner + Vue Test Utils under test/unit/
• Lints and validates each component and utility
• CI/CD
• Travis CI (.travis.yml) triggers builds, tests, coverage (Codecov)
• On release, publishes to NPM