aleitas-test-components v0.2.9
vue-component-examples
This repository represents basic vue.js components to be the starter for Eduworks web applications and websites.
Each component should get a .vue .stories.js and .css file within the stories directory.
##.vue Contains that components with it's HTML, props, methods, etc.
##.stories.js A javascript file for running the component, displaying options such as props, args, etc in the storybook UI.
##.css Plain css, using css variables for now. Naming convention should match BEM style starting with ".ew" for web applications and general componanets and ".ewsite" for components that are specific to websites such as "hero" components.
Project setup
npm install
Compiles and hot-reloads for development
npm run serve
Compiles and hot-reloads storybook development
npm run storybook
Compiles and minifies for production
npm run build
Lints and fixes files
npm run lint
Documenting components
See Docs Blocks
Documentation is available in the storybook UI as the second tab near the top "docs". When running build with the --docs flag the UI will default to this tab.
You can modify descriptions of the component itself in the top level export or at variant export levels with the story object.