Create e-Cattle is a command line application (CLI) that simplifies the process of creating and configuring Progressive Web App (PWA)-integrated micro-frontend applications for the e-Cattle platform.

🗒️ Sobre o Create e-Cattle

O Create e-Cattle é uma aplicação de linha de comando (CLI) que simplifica o processo de criação e configuração de aplicativos micro-frontend integrados ao Progressive Web App (PWA) para a plataforma e-Cattle.

Com ela é possível criar aplicações base, host e remote, utilizando a arquitetura de module-federation e Progressive Web App (PWA), para a Plataforma e-Cattle.

Os módulos foram desenvolvidos utilizando os principais conceitos arquiteturais de micro-frontend e tecnoplogias atuais para criação de aplicações como Vite, Vue.js, module-federation e PWA.

👩🏿‍💻 Como usar

Antes de utilizar esta ferramente, o usuário deverá verificar se tem os seguintes recursos instalados em seu equipamento:

• Node.js
• Git

Os seguintes passsos deverão ser seguidos para utilizar adequadamente este gerador de projetos:

1. Abra o terminal/prompt de comando de sua preferência. Selecione um local em seu computador em que deseja criar o projeto e digite o seguinte comando:

   npx create-e-cattle-app

2. Em seguida, defina um nome para o projeto.

3. O próximo passo será escolher o tipo de projeto. São três opções para escolher: Base, Host e Remote.

   • Base: Esta opção define uma base mínima para executar de forma integrada o host e o(s) remote(s). O projeto Base conta apenas com um package.json com toda a estrutura e scripts para rodar os demais projetos (host e remote(s)) contidos nele um por um.
   • Host: Cria um projeto base com as configurações necessárias para que seja um micro-frontend integrando com tecnicas de aplicação web progressiva (pwa) que servirá como hospedeiro do(s) remote(s). Já vem com alguns componentes internos (formulário de cadastro de usuário, formulário de login, menu de navegação e registro de aplicação) que poderão ser alterados a gosto do desenvolvedor.
   • Remote: Assim como a opção anterior, escolhendo essa opção será definido um projeto base com as configurações necessárias para que seja um micro-frontend integrado com tecnicas de aplicação web progressiva (pwa) para uma aplicação remote. Entretando essa aplicação não conta com componentes internos.

4. Por último, o usuário deverá escolher se quer que os módulos sejam instados imediatamente ou se ele fará isso em um momento posterior:

Uma mensagem é apresentado após o processo:

Contribuir 🚀

Se quiser contribuir, clone este repositório, crie sua própria branch de trabalho e mãos à obra!

git clone https://github.com/andre-violin/create-e-cattle-app.git

git checkout -b feature/NAME

No final, abra um Pull Request explicando o problema resolvido ou a funcionalidade adicionada. Se existir, adicione capturas de tela das modificações visuais e aguarde pela revisão!

Como criar uma Pull Request | Padrão de Commits

Licença 📃

Este projeto está sob a licença MIT license