search

arielsalminen / vue-design-system

An open source tool for building UI Design Systems with Vue.js
https://vueds.com
MIT License
2.17k stars 224 forks source link

Help in the Getting Started #96

Closed angeliski closed 5 years ago

angeliski commented 6 years ago

Hey @viljamis Really great job. The vue-design-system is amazing! I would like some help in the getting started... I have in my stack a project who have my components (e.g: erp-components) and I would like to create the design system using that lib.

How I can do that?

I need put my project erp-components inside the vue-design-system (I would like to avoid that) or I can create a new project using the vue-design-system and import the components... I Read the Getting Started but not is clearly to me. You can provide some example external the vue-design-system

Anyway, thanks for share the project.

arielsalminen commented 6 years ago

@angeliski Hey! Just returned from a 5 week “offline” trip, hence the little delay here. Let me get back to this early next week when I’ve survived the jet lag :)

angeliski commented 6 years ago

Hey @viljamis Any update?

arielsalminen commented 5 years ago

@angeliski So sorry for the long delay! First question: is “erp-components” a vue project?

angeliski commented 5 years ago

No problem @viljamis So, erp-components it is like a lib component, like bootstrap, or bulma. I separate the Vue components from my application, so I can use them in other projects, understand? Now I like to create a project using vue-design-system and use the components inside erp-components to expose the documentation.

angeliski commented 5 years ago

hey @viljamis Do you have any ideia or feedback?

arielsalminen commented 5 years ago

@angeliski Just to make sure I understand correctly, you want to import components from vue design system into the erp-components project?

…or…

You want to import erp-components into Vue Design System as well so that they show up in the documentation and become part of the design system?

angeliski commented 5 years ago

I want to import erp-components into Vue Design System to create a documentation :)

arielsalminen commented 5 years ago

@angeliski If you only want to create a documentation I think it would make more sense to install vue-styleguidist to your erp-components project via npm and let that handle it for you?

angeliski commented 5 years ago

Yeah, I can run the vue-styleguidist, but I like to use vue-design-system. I prefer vue-design-system because he has more semantic for design team, and I don't need configure a lot of things. I don't can run vue-design-system with custom components, from another package?

arielsalminen commented 5 years ago

@angeliski You can, of course, but the documentation you need for that can be found from the Styleguidist side since Vue Design System is build on top of Vue Styleguidist.

Here’s Vue Styleguidist’s example on how to import components from Vuetify library: https://github.com/vue-styleguidist/vue-styleguidist/tree/master/examples/vuetify

Here’s related discussion that hopefully helps you further: https://github.com/vue-styleguidist/vue-styleguidist/issues/92

angeliski commented 5 years ago

Thank you @viljamis I will take a look