@theolonius/cacli v0.1.3

CACLI - Clean Architecture CLI

CACLI é uma ferramenta de linha de comando para geração rápida de projetos baseados na Clean Architecture, incluindo integração com Docker, Prisma, e TypeScript.

📦 Instalação

Certifique-se de ter o Node.js (v16 ou superior) e o Docker instalados.

Para instalar o pacote globalmente:

npm install -g @theolonius/cacli

🚀 Como Usar

Após instalar, você pode usar o comando cacli para criar projetos ou adicionar entidades.

Criar um Novo Projeto

cacli

1. Escolha a opção Criar novo projeto.
2. Informe o nome do projeto.
3. O CLI configurará automaticamente:
   • Estrutura de pastas no padrão Clean Architecture.
   • Docker Compose para rodar o banco de dados PostgreSQL.
   • Configuração do Prisma.
   • Instalação de dependências.

Criar uma Nova Entidade

Dentro de um projeto existente:

cacli

1. Escolha a opção Criar nova entidade.
2. Informe o nome da entidade.
3. O CLI gerará automaticamente:
   • Modelo da entidade.
   • Interface do repositório.
   • Repositório Prisma.
   • Caso de uso.
   • Controlador e rota Express.

📂 Estrutura Gerada

Ao criar um novo projeto, a seguinte estrutura será gerada:

src/
├── adapters/
│   ├── controllers/
│   ├── repositories/
│   ├── routes/
├── application/
│   └── use-cases/
├── domain/
│   ├── entities/
│   └── repositories/
├── infrastructure/
│   ├── config.ts
│   └── database/
│       └── prismaClient.ts

Descrição das Pastas

• adapters: Contém controladores e implementações específicas para o Express e Prisma.

• application: Contém casos de uso que gerenciam a lógica da aplicação.

• domain: Define entidades e interfaces do repositório.

• infrastructure: Configurações globais e inicialização do Prisma.

⚙️ Pré-requisitos

• Node.js: Versão 16 ou superior.
• Docker: Para rodar o banco de dados PostgreSQL via Docker Compose.

💡 Exemplos de Uso

Criar um Novo Projeto

cacli

• Responda as perguntas para criar um projeto configurado com Docker e Prisma.

Adicionar uma Entidade

Dentro do diretório do projeto:

cacli

• Escolha Criar nova entidade e informe o nome.

🛠 Comandos Disponíveis

Iniciar o Servidor

npm run dev

Subir o Banco de Dados

npm run docker

🌟 Recursos Principais

1. Clean Architecture: Código organizado e escalável.
2. Prisma: ORM poderoso para interagir com o banco de dados.
3. Docker: Configuração simplificada do ambiente de banco de dados.

📄 Licença

Este projeto está licenciado sob a MIT License.