@tramon-roma/create-tramon-react

CLI padrão para criação de novos aplicativos React Tramontina de maneira rápida e fácil.

Instalação

Note que a instalação da CLI é necessária apenas uma vez e deve ser feita em escopo global.

Para instalar a CLI de modo global, basta executar o seguinte comando:

yarn global add @tramon-roma/create-tramon-react
# ou
npm install @tramon-roma/create-tramon-react --global

Criando um novo projeto com a CLI

O comando responsável por iniciar um novo projeto é o init. É possível utilizar como argumento tanto o nome do projeto que deseja criar, quanto o link do repositório.

Para criar o projeto, apenas execute o seguinte comando:

# Passando o link do repositório
create-tramon-react init ssh://[email protected]:2222/usuario/novo-projeto.git

# Ou, passando o nome do projeto
create-tramon-react init novo-projeto

Após essa etapa, a CLI irá perguntar algumas informações sobre o projeto que você está criando.

Por último, o programa irá criar a pasta (fazer o clone caso passado um repositório), criar a estrutura de arquivos e baixar as dependências necessárias para começar o desenvolvimento.

Note que essa etapa pode levar alguns minutos devido à instalação das bibliotecas.

Quando terminar de baixar as dependências, você verá a seguinte mensagem:

Basta entrar na pasta do projeto criado e executar o comando de start e você vai ver a aplicação template rodando.

Atualização

Para atualizar a CLI para a última versão, execute o seguinte comando:

yarn global upgrade @tramon-roma/create-tramon-react
# ou
npm update @tramon-roma/create-tramon-react --global

Contribuindo para a CLI

1. Faça o clone do repositório

   git clone ssh://[email protected]:2222/ricardo.dalcin/create-tramontina-react.git

2. Após isso, faça as alterações necessárias nos arquivos de configuração, template, etc.

3. Antes de publicar, é necessário alterar a versão da biblioteca no arquivo package.json.

4. Faça o commit das alterações realizadas.

5. Por último, para publicar a biblioteca no npm, execute o seguinte comando:

   npm publish