@govbr-ds/webcomponents 1.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 SERPRO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,145 @@
+# GOVBR-DS - Web Components
+
+Biblioteca de Web Components baseado no [GOVBR-DS](https://gov.br/ds 'GOVBR-DS').
+
+## Objetivo
+
+Construir uma biblioteca de componentes que faça uso das tecnologias de Web Components e que seja reutilizável em vários frameworks, bibliotecas e browsers.
+
+## Tecnologias
+
+Esse projeto é desenvolvido usando:
+
+1. [VueJS 3](https://v3.vuejs.org/ 'VueJS 3')
+1. [1.Storybook](https://storybook.js.org/ 'Storybook')
+1. [Jest](https://jestjs.io/ 'Jest')
+
+Para saber mais detalhes sobre Web Components sugerimos que consulte o [MDN](https://developer.mozilla.org/pt-BR/docs/Web/Web_Components 'Web Components | MDN').
+
+### Dependências
+
+Para conseguir usar nossa biblioteca sem problemas temos as seguintes dependências:
+
+1. [GOVBR-DS](https://gov.br/ds/ 'GOVBR-DS')
+
+1. [Font Awesome](https://fontawesome.com/ 'Font Awesome')
+
+1. [Fonte Rawline](https://www.cdnfonts.com/rawline.font/ 'Fonte Rawline')
+
+> O fontawesome e a fonte rawline podem ser importadas de um CDN. Consulte a documentação no site do [GOVBR-DS](https://www.gov.br/ds/ 'GOVBR-DS') para mais detalhes.
+
+## Como usar nossa biblioteca em seu projeto?
+
+### Uso de polyfill
+
+Caso os requisitos to seu projeto incluam navegadores que não suportam completamente os Web Components, adicione os [polyfills](https://www.webcomponents.org/polyfills) ao seu projeto.
+
+Para aprender com instalar, consulta a [documentação oficial](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs 'Polyfills')
+
+### Instalação da biblioteca
+
+Você pode instalar a nossa biblioteca de Web Components no seu projeto usando:
+
+```node
+npm install --save @govbr-ds/webcomponents
+```
+
+### Uso
+
+Depois de instalada, importe a biblioteca de dentro da parta node_modules
+
+```javascript
+@import "node_modules/@govbr-ds/webcomponents/dist/webcomponents.umd.min.js"
+```
+
+## Exemplos de uso
+
+Disponibilizamos alguns exemplos de como usar esse projeto com algumas tecnologias. Consulte o [nosso grupo aqui no giltab](https://gitlab.com/govbr-ds/dev/wbc 'GOVBR-DS/DEV/WBC') e procure pelos projetos de 'Quickstart' para mais detalhes.
+
+## Documentação
+
+Nossa documentação está disponível em <https://govbr-ds.gitlab.io/dev/wbc/govbr-ds-wbc/>.
+
+## Como executar o projeto?
+
+Para executar a nossa biblioteca a partir do código-fonte você tem 2 opções:
+
+###  Executar como VueJS
+
+Nessa visualização você executa o projeto em uma página auxiliar (fora do storybook) e sem compilar o resultado para Web Components.
+
+```node
+npm run serve
+```
+
+###  Executar como Web Components
+
+Nessa visualização o projeto é executado a partir do storybook e convertido para Web Components.
+
+Aqui você consegue testar as configurações, obter snippets de código e visualizar os componentes rodando como nos ambientes de produção.
+
+```node
+npm run storybook
+```
+
+Essa compilação pode demorar para refletir as alterações na página. Assim, recomendamos que utilizem primeiro a execução como VueJS durante o desenvolvimento e quando considerarem as alterações maduras o suficiente façam os testes como Web Components.
+
+##  Compilar biblioteca
+
+Gera o build da biblioteca dentro da pasta **dist**.
+
+```node
+npm run build
+```
+
+##  Testes unitários
+
+Executa os testes unitários e sava os resultados na pasta coverage.
+
+```node
+npm run test:unit
+```
+
+##  Lints
+
+Nesse projeto usamos diversos tipos de lints para automaticamente verificar o código antes de enviar para review. Para executá-los e obter os resultados execute o comando:
+
+```node
+npm run lint
+```
+
+## Como contribuir?
+
+Por favor verifique nossos guias de [como contribuir](./CONTRIBUTING.md 'Como contribuir?').
+
+## Reportar bugs/necessidades
+
+Você pode usar as [issues](https://gitlab.com/govbr-ds/dev/wbc/govbr-ds-wbc/-/issues/new) para nos informar os problemas que tem enfrentado ao usar nossa biblioteca ou mesmo o que gostaria que fizesse parte do projeto. Por favor use o modelo que mais se encaixa na sua necessidade e preencha com o máximo de detalhes possível.
+
+Nos comprometemos a responder a todas as issues
+
+## Precisa de ajuda?
+
+> Por favor **não** crie issues para fazer perguntas...
+
+Use nossos canais abaixo para obter tirar suas dúvidas:
+
+-   Site do GOVBR-DS <http://gov.br/ds>
+
+-   Web Components <https://govbr-ds.gitlab.io/dev/wbc/govbr-ds-wbc/>
+
+-   Pelo nosso email <govbr-ds@serpro.gov.br>
+
+-   Usando nosso canal no discord <https://discord.gg/U5GwPfqhUP>
+
+### Commits
+
+Nesse projeto usamos um padrão para branches e commits. Por favor observe a documentação na nossa [wiki](https://govbr-ds.gitlab.io/govbr-ds-wiki/ 'Wiki') para aprender sobre os nossos padrões.
+
+## Créditos
+
+Os Web Components do [GOVBR-DS](https://gov.br/ds/ 'GOVBR-DS') são criados pelo [SERPRO](https://www.serpro.gov.br/ 'SERPRO | Serviço Federal de Processamento de Dados') e [Dataprev](https://www.dataprev.gov.br/ 'Dataprev | Empresa de Tecnologia e Informações da Previdência') juntamente com a participação da comunidade.
+
+## Licença
+
+Nesse projeto usamos a licença MIT.