@captalys-platform/jovian-cli

Jovian CLI

Aplicação de linha de comando para criação de projetos do zero utilizando o Jovian.

Configurando o ambiente

Pré-Requisitos

Antes de começar será preciso instalar o Node.js >= 14.16.1 e um gerenciador de pacotes (NPM/Yarn).

Veja mais em: Node.js e Yarn.

Instalando as dependências

Para instalar os pacotes, rodar na raiz do projeto:

npm install ou yarn

Estrutura do projeto

• commands: Arquivos contendo os comandos da aplicação

  • jovian: Imprime mensagem de boas vindas no terminal, para testes

  • init: Iniciar uma aplicação utilizando o Jovian, aceitando os seguintes argumentos

    • name: Nome da aplicação
    • template: Template utilizado para criar a aplicação

  • publish: Publicar uma aplicação no git, aceitando os seguintes argumentos

    • client: Cliente do git
    • name: Nome do projeto (caso este argumento não seja passado, será utilizada a propriedade name do arquivo package.json)

Utilizando a linha de comando para testes

# Navegar até a pasta bin
$ cd bin

# Criar um link simbólico para utilizar o comando externamente
$ sudo ln -s "$(pwd)"/jovian /usr/bin/jovian-cli

# Navegar até a pasta que o projeto será iniciado e executar o seguinte comando
$ jovian-cli

# Deverá retornar a mensagem de boas vindas
Welcome to your CLI

# Para criar uma aplicação de testes, navegar até a pasta desejada e executar o seguinte comando
$ jovian-cli init --name=app-teste

Gluegun

Este projeto foi criado utilizando o Gluegun.

Publicando no NPM

Para publicar no NPM, são necessários os seguintes passos:

$ npm login

$ npm whoami

$ npm lint

$ npm test

# Se estiver utilizando typescript
$ npm run build

$ npm publish

Tarefas e prioridades

O board de tarefas pode ser encontrado nesse link. As tarefas geralmente são ordenadas por ordem de prioridade, considerando o topo como mais prioritárias. Entretanto é importante estar atento na propriedade prioridade de cada tarefa e nas reuniões de planejamento para estar atento às prioridades do projeto.

Bugs

Para reportar um bug é possível utilizar o board de Bugs. É recomendável conversar com o tech lead previamente afim de garantir que realmente se trata de um bug, e que é necessário abrir uma atividade de bug.

Dúvidas

Caso persistam as dúvidas, é possível buscar por informações na documentação do confluence e em último caso, procurar por algum colega do time ou o tech lead. SQUAD Front End

Licença

© 2021 Captalys - Todos os direitos reservados.