Periodic - The AAP Design System
Just as the Periodic Table of Elements lets us see all of the elements that we have to work with in the material world, Periodic is our design system which lets us showcase all of the UI elements that we have to work with for all of our projects.
Getting Started
This project is a fork of the fantastic Vue Design System, tweaked to fit AAP's needs. All of the documentation listed below is on the official Vue Design System repo, which is 100% applicable to this repo as well.
Documentation
- Getting Started: How to install and run Vue Design System.
- Terminology: Introduction to the system concepts and its hierarchy.
- Naming of Things: Naming is hard, so it’s good to have clear guidelines.
- Directory Structure: What goes where and why.
-
Working with the System: Concrete examples on how to work with
Tokens,Elements,PatternsandTemplates. - Editing Living Documentation: How to customize the living system documentation.
- Spacing: A framework for creating a predictable and harmonious spacing.
- Component Status: Clear labels that reflect the state of completion.
- Component QA: How to review new components and keep the quality high.
- Contributing: A set of guidelines for contributing to the system.
- Code of Conduct: By participating you agree to abide by its terms.
- Frequently Asked Questions: How to use icons, how to use font-face, etc.
License
Licensed under the MIT license.