Setup do Ambiente.

Requisitos

• React 18 e typescript
• utilizar o yarn para instalação mas utilizar o npm para publicação
• Permissões para utilizar o Azure Artifacts no escopo da organização "ftd-educacao";

Instalação

yarn

Para publicação no azure artefacts

Obs.: Devendo ser usada após a validação do UX na esteira. Caso a pipe ainda não tenha sido criada.

1 - configure o seu acesso ao Azure Artifacts como explicado aqui. Observe que o arquivo de configuração .npmrc do projeto já esta configurado corretamente e faz parte do código versionado.

Obs.: localmente, exporte a variável NPM_CONFIG_NPMRC_PASSWORD, no bash, com o comando: export NPM_CONFIG_NPMRC_PASSWORD=VALOR_DO_SEU_PERSONAL_TOKEN

2 - Após isso, rode o comando:

npm publish-ds

Convenções e Padrões de Contribuição

Pode ser encontrado no arquivo: principles

Nomeação de Branches

Sempre que possível, utilize o seguinte padrão para nomeação de branches:

<type>/<name>

Em que <type> é um dos seguintes valores:

• bug - Mudanças no código relacionadas a algum bug conhecido.
• feat - Nova funcionalidade.
• fix - Correções rápidas na base de código.
• perf - Melhorias relacionadas á performance, refatoração, instrumentação, etc.
• junk - Experimentos e POCs que não devem ser integrados à quaisquer outras branches.

E <name> é um nome relacionado ao que será desenvolvido (utilize sempre kebab-case).

Exemplos:

• fix/missing-serializer-field;
• feat/expand-card;
• bug/404-when-user-exists;
• perf/cache-layer-setup;
• junk/azure-pipelines-test-playgroud;

Lembre-se também de remover as branches criadas após serem integradas à master.

SRC

Local onde estão contidos o app-theme (design da aplicação), todo o fontes das paginas e também os componentes, atamos moleculas e organismos.

Sotorybook

Local onde estão contidos todos os arquivos .js relacionadas ao Sotorybook, no caso o main.js e o preview.js.

Resources

Local onde estão contidas as img do Sotorybook.

Scaffdog

Local onde estão contidos alguns elementos referente ao Scaffdog, como atamos, molecula e organismo e também o aquivos de configuração do JS.

husky

Instalação, para adicionarmos o husky ao projeto, execute o comando a seguir:

yarn add husky

Configurando o husky para executar o Git

"husky": {},

"husky": {
  "hooks": {}
},

“husky”: {
  “hooks”: {
    “applypatch-msg”: “echo \”[Husky] applypatch-msg\””,
    “pre-applypatch”: “echo \”[Husky] pre-applypatch\””,
    “post-applypatch”: “echo \”[Husky] post-applypatch\””,
    “pre-commit”: “echo \”[Husky] pre-commit\””,
	}
}

Commits

utilizar o padrão do Git Flow.

Versões

Aqui você pode conferir todas as versões lançadas do Design System até o momento

Versões

Documentacao

A documentacao oficial do projeto está no sharepoint