@labz/ei-co-hosts-dashboard NPM

E-i Co-hosts Dashboard

Aplicativo react responsável por disponibilizar uma dashboard para o dono/moderador de eventos Streaming poder convidar co-hosts/palestrantes para participarem do evento.

Este app se comunica com o micro-serviço ei-jaas-8x8 para realizar a listagem, adição e remoção de co-hosts.

Este app utilza o design system da Raise.

Storybook disponível aqui.

Instalação :man_technologist:

Para instalar as dependências do app:

yarn

Após concluir instalações, para rodar localmente:

yarn start

Se tudo der certo, o app rodará no endereço http://localhost:8080/ em seu navegador (se nada já estiver rodando nessa porta). Caso der algum erro, as mensagens disponibilizadas pelo webpack no terminal devem ajudar a encontrar o problema.

DEMO :test_tube:

Existe um github action já configurado para realizar um deploy no surge, para averiguaçaõ de produto e testes. É preciso comitar na branch main para rodar a ação do github que irá utilizar o comando build. Certifique-se de utilizar as variáveis corretas, configurando no dataset do index.html.

Por padrão, já estão configuradas variáveis para teste no ambiente

de desenvolvimento. Elas são sobrescritas pelas variáveis passadas pelo rails quando o react é importado no E-inscrição.

Se quiser publicar manualmente, faça a build rodando o comando build e utilize o surge normalmente (surge -s dist).

Build e publicação :truck:

Após realizar alguma modificação, é necessário buildar o projeto para gerar um umd pronto para publicação. Antes de rodar o comando abaixo para gerar a build, certifique-se de atualizar a versão do projeto no package.json, pois esta versão é a que irá aparecer no rodapé do app.

yarn build

Isso irá gerar um diretório /dist na raiz do projeto, contendo um bundle da aplicação, pronto para ser publicado no npm que gera automaticamente a disponibilidade do pacote no unpkg (cdn utilizado atualmente).

Para realizar a publicação, certifique-se de estar cadastrado na organização @labz da Raise no npm. A organização ou cdn podem mudar, portanto certifique-se de perguntar as pessoas responsáveis para informações sobre onde estão sendo publicados os apps da empresa.

Já cadastrado e logado no npm localmente, rode o comando abaixo:

yarn publish

Se tudo estiver certo, o terminal pedirá o número da versão nova a ser publicada. Verifique qual será acessando o npm do pacote, insira e dê enter para realizar a publicação.

Com isso, será possível importar o aplicativo através do cdn em uso.

Projeto criado usando o padrão webpack-boilerplat.

:memo: Por favor, não esqueça de atualizar esta documentação quando necessário! :memo: