andrewronscki/awr-cli

🤖 AWR CLI

⚙️ A CLI para padronizar a criação e evolução de nossos projetos. 💗

Tabela de conteúdos

• Sobre o projeto
• Funcionalidades
• Como executar o projeto
  • Pré-requisitos
  • Rodando/Criando um executável novo para a CLI
• Tecnologias
  • CLI
• Estrutura do Template do Projeto
• Como usar
  • No Linux
• Autor
• Licença

💻 Sobre o projeto

🤖 AWR CLI - é uma forma de criar e evoluir projetos utilizando o padrão adotado pela AWR.

É uma Interface de Linha de Comando que permite criar novos projetos em NestJS utilizando Clean Archtecture e DDD.

---

⚙️ Funcionalidades

• NestJS:
  • Criar projeto com base no template

awr nest new hello-world

---

🚀 Como executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina a seguinte ferramenta: Rust. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando/Criando um executável novo para a CLI

# Clone este repositório
$ git clone git@github.com:andrewronscki/awr-cli.git

# Acesse a pasta do projeto no terminal/cmd
$ cd awr-cli

# Execute a CLI com o seguinte comando
$ cargo run nest new hello-world

# Será criado uma pasta com o nome hello-world e nele irá conter o template do projeto
# Na pasta target/debug terá sido criado um arquivo executavel chamado awr, rodando no windows ele criará um executável chamado awr.exe

---

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

CLI (Rust)

• clap
• error-chain
• reqwest
• tokio
• zip

Veja o arquivo Cargo.toml

---

🛠 Estrutura do Template do Projeto

A estrutura do template do projeto segue este modelo:

• O sistema deve ser desenvolvido utilizando os ensinamentos do Clean Architecture e Domain-Driven Design, separando as camadas em domain, data, infra e presentation;
• O sistema deve ser agrupado por módulos independentes;
• O desenvolvimento dos casos de uso deve ser orientado a testes (TDD).

---

👨‍💻 Como usar

Linux

• Baixe o arquivo awr clicando aqui!
• Após baixar, abra o terminal e siga os passos a seguir:

# Criar pasta .awr
mkdir .awr

# Mover arquivo baixado para pasta .awr
mv ~/downloads/awr ~/.awr/

# Dar permissão de execução e escrita para o arquivo
cd .awr
chmod 755 awr

• Adicionar no arquivo .bashrc ou .zshrc o caminho para o executável no PATH:

# Exemplo no .zshrc
export PATH="$HOME/.awr:$PATH"

• Agora basta testar utilizando o seguinte comando em qualquer pasta do seu terminal:

awr nest new hello-world

# Deverá criar uma pasta chamada hello-world com o template do projeto.

-“Que a Força esteja com você”

---

🦸 Autor

_{André Wronscki Ricardo} 🚀

---

📝 Licença

Este projeto esta sobe a licença MIT.