Skip to content

GabrielCirqueira/Catalyst-Skeleton

Repository files navigation

🚀 Catalyst Skeleton v4.0.0 — Symfony 7.3 & React 19

O ponto de partida definitivo para aplicações empresariais sólidas, escaláveis e resilientes.

Catalyst Skeleton é uma suite completa de engenharia que impõe padrões de Clean Architecture, DDD e SOLID. Backend PHP 8.4 + Symfony 7.3 com JSON API. Frontend React 19 + TypeScript como SPA. Tudo containerizado, production-ready desde o primeiro commit.

image

📅 Histórico de Versões

O roadmap do Catalyst Skeleton é focado em estabilidade e modernização constante da stack.

Versão Data de Lançamento Destaque Principal
Skeleton V4 23 de março 2026 Atual — Symfony 7.3, React 19, Biome.
Skeleton V3 6 de outubro 2025 Estabilização de Message Bus e Workers.
Skeleton V2 1 de junho 2025 Introdução de Shadcn UI e Lucide Icons.
Skeleton V1 30 de janeiro 2025 Release inicial (Symfony 6.4 + React 18).

Para documentação técnica detalhada (arquitetura, variáveis de ambiente, DevOps, deploy, logs, etc.) consulte DOCUMENTACAO_TECNICA.md.


Pré-requisitos

Ferramenta Verificação
Docker + Docker Compose v2 docker compose version
Git git --version
OpenSSL openssl version

Node.js e PHP não precisam estar instalados na máquina host.


🛠️ Setup Inicial (The Magic Script)

O Catalyst Skeleton possui um orquestrador de setup altamente sofisticado que prepara todo o seu ambiente profissional em minutos.

bash scripts/setup.sh

O que o setup faz por você:

  1. Personalização: Renomeia o projeto em todos os arquivos (package.json, namespaces, banners).
  2. Gestão de Portas: Permite configurar portas customizadas para evitar conflitos locais.
  3. Segurança Máxima: Gera segredos aleatórios (APP_SECRET, JWT_PASSPHRASE) e senhas únicas de banco.
  4. Ambiente Isolado: Cria seu arquivo .env configurado com DSNs e URLs corretos.
  5. Orquestração Docker: Realiza o build multi-stage e sobe os containers de forma resiliente.
  6. Instalação de Deps: Instala dependências PHP (Composer) e JS (NPM) dentro do ambiente isolado.
  7. Criptografia: Gera o par de chaves RS256 (pública/privada) para o subsistema de JWT.
  8. Sincronização: Aguarda o banco estar pronto e executa as Migrations automaticamente.
  9. Health Check: Valida a saúde final da API antes de declarar o sucesso do setup.

Serviço Porta (Host) Destino
API Symfony BACKEND_PORT http://localhost:4355
Frontend Vite FRONTEND_PORT http://localhost:3453
MySQL DATABASE_PORT localhost:2345
Supervisor SUPERVISOR_PORT http://localhost:1011

Tip

As portas são centralizadas no arquivo ports.env. O setup pergunta quais você deseja usar, mas você pode alterá-las a qualquer momento e rodar make restart.



🛠️ Comandos do dia a dia

Comando Descrição
make up-d Sobe a stack completa em background
make down Para todos os containers
make restart Reinicia todos os serviços
make install Instala dependências (Composer + NPM)
make migrate Executa migrations pendentes
make test Roda suite completa de testes (PHPUnit)
make lint-all Valida estilo (PHP-CS-Fixer + Biome)
make bash-backend Acessa shell do container Symfony

🏗️ Arquitetura (Visão Rápida)

O Catalyst Skeleton impõe uma separação rigorosa de interesses:

  • Backend: Baseado em Services Atômicos e DTOs. A lógica de negócio nunca vaza para o Controller.
  • Frontend: Organizado por Features. Cada funcionalidade (Auth, User, etc) é um módulo autossucedido.
  • Padrão Resultado: Todas as operações de negócio retornam um objeto Resultado em vez de lançar exceções.

📚 Documentação Detalhada

Para uma imersão profunda em cada área do projeto, consulte nossos guias específicos:


🚀 Produção e DevOps

Desenvolvido para ser Production Ready:

  • Deploy: Script devops/deploy.sh com zero-downtime aproximado e healthchecks.
  • Segurança: Nginx configurado com TLS 1.3 e headers de segurança (HSTS, CSP).
  • Monitoramento: Painel Supervisor para gestão de workers e logs estruturados.

Para uma visão técnica global e variáveis de ambiente, veja DOCUMENTACAO_TECNICA.md.

About

No description, website, or topics provided.

Resources

License

Stars

2 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors