forms-del-vue v1.0.0

Forms Del Vue

What is it?

forms-del-vue is a library of Vue components with an emphasis on building forms. This library is mostly for study purposes, not for production ready projects.

Usage

Installation

Currently the only way to install is to use the source code.

Importing Components

import { Dummy } from 'forms-del-vue'

Voila!

Development

TypeScript

This library is written in TypeScript because strong typing is awesome

TDD

This library places an emphasis on writing modular chunks of code that can be automatically tested. Just run

> npm run dev:test

while developing to see changes in real time, or

> npm run jest

for a single run of tests.

Storybook

You can interact with components while building them using Storybook. Just run

> npm run storybook

to spin up the Storybook dev server.

Builds

Run

> npm run build

to clean up your code with Prettier, clean out the dist directory and build a fresh bundle using Webpack.

Directory Structure

Each Vue component in the project has its own folder with the same basic structure:

VueComponent/
├── VueComponent.md
├── VueComponent.spec.ts
├── VueComponent.stories.ts
└── VueComponent.vue

• The .md file is used to document what a component is for and how to use it
• The .spec. file is used to store unit tests for the component
• The .stories. file is used to write up stories for Storybook for the component
• The .vue file is what we export for usage in other projects