@govbr-ds/webcomponents 1.6.1 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,13 @@
1
1
  # Web Components GovBR-DS
2
2
 
3
- Biblioteca baseada no [GovBR-DS](https://gov.br/ds 'GovBR-DS') e construída usando Web Components para ser independente de frameworks.
3
+ Nosso objetivo é disponibilizar uma biblioteca de componentes baseada no [GovBR-DS](https://gov.br/ds 'GovBR-DS') que possa ser consumida independente de frameworks ou tecnologias utilizadas nos projetos.
4
+
5
+ ## Demonstração
6
+
7
+ Acesse nossos sites e veja nossos componentes em ação:
8
+
9
+ - [Storybook - Produção](https://gov.br/ds/webcomponents/)
10
+ - [Storybook - Desenvolvimento](https://govbr-ds.gitlab.io/wbc/govbr-ds-wbc/)
4
11
 
5
12
  ## Tecnologias
6
13
 
@@ -61,32 +68,23 @@ Disponibilizamos alguns exemplos de como usar esse projeto com algumas tecnologi
61
68
 
62
69
  ```markdown
63
70
  /raiz
64
- └───public
65
- │ └───index.html
66
71
  └───src
67
- │ │───App.vue
68
- │ │───main.js
69
- │ │
70
- │ │───library
71
- │ │ │───lib.js
72
- │ │ │───components
73
- │ │ │───mixins
74
- │ │ └───util
75
- │ │───pages
76
- │ │───router
77
- │ └───stories
72
+ │───assets
73
+ │───library
74
+ │ │───lib.js
75
+ │ │───components
76
+ │ │───mixins
77
+ │ └───util
78
+ └───stories
78
79
  ```
79
80
 
80
- - **public/index.html**: página inicial da aplicação Vue que faz uso dos componentes da biblioteca.
81
81
  - **src**
82
- - **App.vue** e **main.js**: arquivos da aplicação Vue.
82
+ - **assets**: pasta com arquivos estáticos
83
83
  - **library**
84
84
  - **lib.js**: inicializa todos os custom elements e define o que faz parte da biblioteca. É usado para fazer o build final.
85
85
  - **components**: pasta com os componentes da biblioteca, seus testes e stories do storybook.
86
86
  - **mixins**: mixins que são usados em vários componentes.
87
87
  - **util**: funções criadas para facilitar ações dentro dos componentes
88
- - **pages**: páginas da aplicação Vue. São os exemplos que usamos para testar
89
- - **router**: arquivo com as rotas apontando para as páginas (pages) da aplicação Vue
90
88
  - **stories**: Arquivos com as stories gerais do storybook
91
89
 
92
90
  > Aplicação Vue é uma aplicação criada para testar rapidamente nossos componentes. Ela não é disponibilizada no build e nem disponibilizamos um site com ela.
@@ -137,6 +135,8 @@ Essa compilação pode demorar para refletir as alterações na página. Assim,
137
135
 
138
136
  Nossa documentação está disponível em <https://gov.br/ds/webcomponents/>.
139
137
 
138
+ > Para outras informações, consulte nossa [Wiki](https://govbr-ds.gitlab.io/tools/wiki/hugo-cms/desenvolvimento/web-components/).
139
+
140
140
  ## Contribuindo
141
141
 
142
142
  Antes de abrir um Merge Request tenha em mente algumas informações: