README.md

vuetibook

Experimenting the integration between Vue.js, Vuetify and Storybook.

Some tools like Vue I18n and Vuex are also used in order to make the project similar to what a real application would be.

Deployed on Netlify

• https://vuetibook.netlify.com
• https://components-vuetibook.netlify.com
• https://docs-vuetibook.netlify.com

Dockerize for development

docker-compose up

• App: http://vuetibook.local:8080/
• Storybook: http://components.vuetibook.local:8080/
• Documentation: http://docs.vuetibook.local:8080/
• Mock Server: http://mocks.vuetibook.local:8080/

Local Installation

Project setup

# app & storybook
yarn install

# docs
cd docs
yarn install

# mocks
cd mocks
yarn install

Available Commands

# app
yarn serve # Compiles and hot-reloads for development
yarn build # Compiles and minifies for production

# Storybook
yarn serve:storybook # Compiles and hot-reloads for development
yarn build:storybook # Compiles and minifies for production

# Run unit tests
yarn test:unit

# Documentation
cd docs
yarn serve:docs # Compiles and hot-reloads for development
yarn build:docs # Compiles and minifies for production

# Mock Server
cd mocks
yarn serve # Hot-reloads for development

Built With

Base Tools

• Vue.js
• Vue CLI 3
• Vue Router
• Vuex
• Axios
• Storybook
• Docker

Internationalization

• Vue I18n

Material Design

• Vuetify

mock Server

• Mock Json Server

Analytics

• Google Tag Manager
• Google Analytics

Testing

• Vue Test Utils
• Jest
• Cypress

Documentation

• VuePress

Versioning

We use SemVer for versioning and Keep a Changelog for the format of the ChangeLog. For the versions available, see the tags on this repository.