|
1 | | -# Pimbastic Esports |
2 | | - |
3 | | -Sistema Web para cadastro de campeonatos, times, jogos, clientes e apostas em eSports. O projeto foi migrado e atualizado para utilizar o framework **CodeIgniter 4**, com um front-end completo, moderno e responsivo. |
4 | | - |
5 | | ---- |
6 | | - |
7 | | -## 🚀 Novidades desta Versão (Entrega 3) |
8 | | -- **Framework CodeIgniter 4**: Migração completa da arquitetura do projeto para a estrutura padrão MVC (Model-View-Controller) do CI4. |
9 | | -- **Roteamento Estrito**: Rotas configuradas no arquivo `app/Config/Routes.php` agrupando as funcionalidades de clientes (`/cliente`) e administração (`/admin`). |
10 | | -- **Aparência Premium (eSports Theme)**: Layout escuro de alta fidelidade com fontes modernas (`Chakra Petch` para interface e `Bebas Neue` para títulos), efeitos neon (verde/ciano) e transparências estilo glassmorphism. |
11 | | -- **Interface Responsiva**: Todo o painel e formulários se adaptam para dispositivos móveis e desktops com navegação retrátil. |
12 | | -- **Consumo de Mocks**: Listagens, histórico e formulários dinâmicos consumindo dados pré-configurados nos controllers PHP (SSR). |
13 | | -- **Interatividade no Sportsbook**: Odds funcionais com seleção dinâmica via JavaScript no formulário de aposta e estimativa de retorno em tempo real. |
14 | | - |
15 | | ---- |
16 | | - |
17 | | -## 📂 Estrutura do Projeto |
18 | | -- `app/Config/Routes.php`: Rotas centralizadas do framework. |
19 | | -- `app/Controllers/`: Controladores contendo regras de negócio e mocks de dados SSR (`AuthController`, `ClienteController`, `AdminController`, etc.). |
20 | | -- `app/Views/`: |
21 | | - - `layouts/master.php`: Layout base com importações de fontes, Tailwind CSS e navegação do portal. |
22 | | - - `auth/`: Telas de login e cadastro. |
23 | | - - `cliente/`: Sportsbook e histórico de apostas. |
24 | | - - `admin/`: Painel de controle e sub-telas de gerenciamento (campeonatos, times, usuários). |
25 | | -- `public/index.php`: Front Controller que inicializa o CodeIgniter 4. |
26 | | -- `backup_old_system/`: Cópia de segurança contendo os arquivos PHP avulsos da entrega anterior. |
27 | | - |
28 | | ---- |
29 | | - |
30 | | -## 🛠️ Como Executar o Projeto |
31 | | - |
32 | | -### Pré-requisitos |
33 | | -- Docker Desktop (ou Docker Engine + Docker Compose) instalado e rodando. |
34 | | -- Porta `8080` livre na máquina host para a aplicação. |
35 | | - |
36 | | -### Passo a Passo |
37 | | - |
38 | | -1. **Inicie os Containers do Docker (Limpando Volumes Antigos):** |
39 | | - Para garantir que o banco de dados e os novos volumes temporários sejam mapeados do zero, no diretório raiz do projeto execute: |
40 | | - ```bash |
41 | | - docker compose down -v |
42 | | - docker compose up --build |
43 | | - ``` |
44 | | - |
45 | | -2. **Acesse no Navegador:** |
46 | | - Abra o seu navegador de preferência e entre em: |
47 | | - ```text |
48 | | - http://localhost:8080 |
49 | | - ``` |
50 | | - |
51 | | ---- |
52 | | - |
53 | | -## 🎮 Roteiro de Teste (Como Avaliar) |
54 | | - |
55 | | -O sistema conta com um redirecionamento inteligente na tela de login para facilitar a navegação rápida entre os dois perfis da aplicação: |
56 | | - |
57 | | -1. **Acesso do Administrador (Dashboard & Cadastros):** |
58 | | - - Acesse `http://localhost:8080` (será redirecionado para a tela de login). |
59 | | - - Digite qualquer e-mail que contenha a palavra **`admin`** (ex: `admin@pimbastic.com`) e qualquer senha. |
60 | | - - Clique em **Entrar no Sistema**. |
61 | | - - Você será levado ao **Painel Administrativo** exibindo métricas do sistema e status online. |
62 | | - - Navegue pelo menu lateral para acessar as listagens de **Campeonatos**, **Times** e **Usuários**. |
63 | | - - Em cada listagem, clique no botão de **Novo Cadastro** para abrir os formulários com validações de campos. Preencha e salve (o sistema simula o salvamento e retorna feedback visual de sucesso). |
64 | | - |
65 | | -2. **Acesso do Cliente (Sportsbook & Apostas):** |
66 | | - - No cabeçalho, clique em **Sair** para retornar ao Login. |
67 | | - - Digite qualquer e-mail comum (ex: `cliente@pimbastic.com` ou `player@gmail.com`) e qualquer senha. |
68 | | - - Clique em **Entrar no Sistema**. |
69 | | - - Você será levado ao **Mercado de Apostas (Sportsbook)** do cliente. |
70 | | - - O sportsbook exibe o saldo do usuário (R$ 1.500,50) e cards interativos com jogos de eSports. |
71 | | - - **Interatividade das Odds**: Clique em um dos botões de odd ("Casa", "Empate" ou "Fora") de um jogo. O botão correspondente ficará marcado com brilho ciano, e um painel de cálculo aparecerá mostrando o retorno estimado da aposta em tempo real ao digitar um valor. |
72 | | - - Insira um valor no input e clique em **Apostar** para registrar a aposta (mensagem de sucesso de mock é exibida). |
73 | | - - Abaixo dos jogos, visualize a tabela com o histórico de apostas realizadas. |
| 1 | +5. Como Executar |
| 2 | +Pré-requisitos |
| 3 | +Docker Desktop ou Docker Engine com o plugin Docker Compose instalado. |
| 4 | + |
| 5 | +Porta do host 8080 e 3306 desocupadas. |
| 6 | + |
| 7 | +Guia Passo a Passo |
| 8 | +Clone do Repositório: |
| 9 | + |
| 10 | +Bash |
| 11 | +git clone <URL_DO_REPOSITORIO> |
| 12 | +cd pimbastic_esports |
| 13 | +Configuração de Variáveis de Ambiente: |
| 14 | +Certifique-se de preencher o arquivo .env na raiz do projeto com as chaves de infraestrutura requisitadas: |
| 15 | + |
| 16 | +Fragmento do código |
| 17 | +MYSQL_ROOT_PASSWORD=root |
| 18 | +MYSQL_DATABASE=pimbastic_esports |
| 19 | +MYSQL_USER=root |
| 20 | +MYSQL_PASSWORD=root |
| 21 | +Inicialização Limpa dos Containers: |
| 22 | +Para limpar qualquer cache ou estado anterior de volumes e subir a infraestrutura completa de forma automatizada: |
| 23 | + |
| 24 | +Bash |
| 25 | +docker compose down -v |
| 26 | +docker compose up --build -d |
| 27 | +Acesso ao Sistema: |
| 28 | +A aplicação estará acessível imediatamente via navegador no endereço: |
| 29 | + |
| 30 | +Plaintext |
| 31 | +http://localhost:8080 |
| 32 | +Provisionamento do Usuário Administrador (Seeder): |
| 33 | +Para gerar as credenciais do primeiro perfil administrativo do sistema, execute o comando interno do framework: |
| 34 | + |
| 35 | +Bash |
| 36 | +php spark db:seed AdminSeeder |
| 37 | +Nota: Caso as variáveis de ambiente de teste não estejam setadas, as credenciais padrão criadas serão: admin@pimbastic.local / senha: admin123. |
| 38 | + |
| 39 | +6. Roteiro de Testes e Validação Tecnológica |
| 40 | +O roteiro de testes simula o comportamento SSR adaptativo baseado em políticas de login de usuário: |
| 41 | + |
| 42 | +Cenário A: Validação do Painel do Administrador |
| 43 | +Navegue até http://localhost:8080 (o filtro de autenticação redirecionará para a tela de login). |
| 44 | + |
| 45 | +Insira um e-mail que contenha o termo admin (ex: admin@pimbastic.local) e preencha qualquer senha. |
| 46 | + |
| 47 | +Clique em Entrar no Sistema. |
| 48 | + |
| 49 | +Valide a renderização do Painel Administrativo: observe os indicadores de métricas e o menu dinâmico de gerenciamento lateral. |
| 50 | + |
| 51 | +Acesse as abas Campeonatos, Times e Usuários. |
| 52 | + |
| 53 | +Realize o teste de entrada de dados clicando em Novo Cadastro. Os formulários possuem interceptores de validação simulados que retornam banners visuais de sucesso. |
| 54 | + |
| 55 | +Cenário B: Validação do Ecossistema do Cliente (Sportsbook) |
| 56 | +Clique em Sair no canto superior direito para limpar a sessão. |
| 57 | + |
| 58 | +Efetue o login utilizando um e-mail comum de cliente (ex: cliente@pimbastic.com). |
| 59 | + |
| 60 | +Confirme o acesso à interface do Sportsbook (exibindo saldo base simulado de R$ 1.500,50). |
| 61 | + |
| 62 | +Interatividade de Odds via JS: Escolha um confronto de eSports e selecione um dos mercados ("Casa", "Empate" ou "Fora"). O elemento ganhará foco neon (ciano). |
| 63 | + |
| 64 | +Digite um valor de aposta no campo apropriado; o script JavaScript processará o cálculo em tempo real exibindo a projeção do retorno financeiro. |
| 65 | + |
| 66 | +Submeta a operação clicando em Apostar para registrar a transação fictícia e verificar o histórico atualizado no rodapé. |
| 67 | + |
| 68 | +7. Evidências Técnicas de Execução |
| 69 | +Abaixo encontram-se os mapeamentos obrigatórios de telas exigidos como artefato de entrega: |
| 70 | + |
| 71 | +I. Containers Docker ativos e saudáveis (docker compose ps) |
| 72 | +II. Aplicação Web acessível via navegador em localhost |
| 73 | +III. Banco de Dados MySQL criado e populado via script automático de inicialização |
| 74 | +""" |
| 75 | + |
| 76 | +with open("README.md", "w", encoding="utf-8") as f: |
| 77 | +f.write(readme_content) |
| 78 | + |
| 79 | +print("README.md successfully optimized and generated.") |
| 80 | + |
| 81 | +O seu arquivo Markdown está pronto |
| 82 | +[file-tag: code-generated-file-0-1780439086781771750] |
| 83 | + |
| 84 | +O arquivo `README.md` foi reestruturado para eliminar redundâncias e garantir a precisão técnica arquitetural exigida pelo trabalho prático. |
| 85 | + |
| 86 | +### Ajustes Arquiteturais e Estruturais Aplicados: |
| 87 | +1. **Unificação de Tópicos:** Seções sobre tecnologias, execução e cenários de testes foram agrupadas logicamente, removendo repetições sobre Docker e comandos de inicialização. |
| 88 | +2. **Funcionamento Interno (Under the Hood):** Adição de uma seção específica detalhando o fluxo de rede isolada via `bridge` (`app-network`), a injeção do volume persistente `db_data` e a automação do schema via `/docker-entrypoint-initdb.d/`, correspondendo à exigência de detalhamento técnico. |
| 89 | +3. **Mapeamento de Estrutura:** O mapa de diretórios reflete agora o padrão MVC autêntico do CodeIgniter 4 integrado aos arquivos de infraestrutura (IaC). |
| 90 | +4. **Padronização de Comandos:** O fluxo de build limpo (`docker compose down -v` seguido de `up --build -d`) foi estabelecido como comando oficial para evitar colisões com instâncias anteriores do container MySQL. |
| 91 | + |
| 92 | +Anexe as imagens (capturas de tela do `docker compose ps`, do Front-End operando e de um `SELECT` demonstrando os dados no SGBD) e referencie-as na seção `7. Evidências Técnicas de Execução` do documento. Não esqueça de inserir também o `diagrama.png` na raiz do projeto. |
0 commit comments