create-icw-api

CLI para criar novos projetos ICW API

🚀 Instalação

npm install -g create-icw-api
# ou use diretamente com npx (recomendado)
npx create-icw-api minha-api

📦 Uso

Criar novo projeto

npx create-icw-api minha-api

Isso irá:

• ✅ Criar a estrutura do projeto
• ✅ Instalar @insightcreativewebs/api automaticamente
• ✅ Configurar TypeScript
• ✅ Configurar scripts do framework

Estrutura criada

minha-api/
├── src/
│   ├── modules/          # Seus módulos aqui
│   └── server.ts         # Entry point
├── .env                  # Gerado automaticamente
├── .env.example          # Referência
├── package.json
├── tsconfig.json
└── README.md

🎯 Próximos Passos

Após criar o projeto:

cd minha-api
npm install
npm run dev

O servidor estará rodando em http://localhost:3000

📝 Scripts Disponíveis

Após criar o projeto, você terá acesso aos seguintes scripts:

• npm run dev - Inicia servidor em modo desenvolvimento
• npm run build - Compila TypeScript
• npm run start - Inicia servidor em produção
• npm run generate:module <nome> - Gera novo módulo
• npm run generate:env - Gera/atualiza arquivos .env

🔧 Configuração

Variáveis de Ambiente

O projeto vem com um envSchema pré-configurado em src/server.ts. Execute:

npm run generate:env

Isso gerará o arquivo .env com todas as variáveis necessárias.

Criar Módulos

npm run generate:module user

Isso cria:

• src/modules/user/user.controller.ts
• src/modules/user/user.service.ts
• src/modules/user/user.rules.ts
• src/modules/user/user.module.ts

📚 Documentação

Para mais informações sobre o framework, consulte:

• @insightcreativewebs/api
• Documentação Completa

🤝 Contribuindo

Contribuições são bem-vindas! Por favor, abra uma issue ou pull request.

📄 Licença

MIT © 2025 Aylon Muramatsu

🔗 Links

• GitHub
• NPM
• Framework

---

Feito com ❤️ por Insight Creative Webs