Laravel MUI Admin

Atenção: Este projeto está em construção. Para colaborar, envie um e-mail para [email protected].

Laravel MUI Admin é um boilerplate para iniciar projetos Laravel + React, oferecendo um conjunto de ferramentas que facilitam o desenvolvimento.

Principais recursos:

• Integração Laravel + React via Laravel UI
• Material UI como framework de componentes: personalização de temas, utilização de componentes prontos e criação de componentes próprios
• Redux como gerenciador de estado global: fácil integração sem necessidade de instalar pacotes adicionais
• React Router para navegação SPA
• Code splitting com React.lazy e mix.extract: otimização de performance com mínimo de código
• Suporte a traduções via react-i18next
• Páginas React integradas ao Laravel: 100% de aproveitamento do React no client-side
• Módulos para elementos CRUD: criação, edição, exclusão e listagem de dados de forma padronizada e simplificada
• Funções JavaScript similares às utilizadas na engine Blade, como route e error
• Facilita migração para PWA
• Serviço React no backend para enviar dados pré-carregados ao frontend
• API com autenticação JWT
• Sistema de permissões baseado em funções pré-configuradas

Ferramentas de desenvolvimento integradas:

• Eslint: regras baseadas no guideline do Airbnb e reforçando boas práticas
• PHP CS Fixer: padronização de código PHP
• Laravel IDE Helper: auxílio no desenvolvimento com IDEs compatíveis (instalar extensão, se necessário)

Implementações iniciais pré-montadas e comandos para criar elementos de frontend no projeto estão disponíveis para acelerar o desenvolvimento.

Instalação

Requisitos

• PHP 7.4+
• Composer
• Node.js 14.0+
• Npm

Passo a passo

1. Clone o repositório
2. Instale as dependências do PHP: composer install
3. Instale as dependências do Node.js: npm install
4. Copie o arquivo .env.example para .env e configure o banco de dados
5. Gere a chave do app: php artisan key:generate
6. Execute as migrations: php artisan migrate --seed e anote a senha do usuário criado
7. Compile o frontend: npm run dev ou npm run hot para desenvolvimento contínuo com hot reloading
8. Inicie o servidor: php artisan serve

Documentação

• Laravel
• React
• Material UI
• Redux
• React Router

Guias

• Início

• Introdução

• Configurando o Ambiente

  • Customizando o tema
  • Criando uma renderização

• Componentes e Rotas

  • Criando Componentes
  • Criando Páginas e Rotas

• Construindo a Aplicação

  • Gerenciamento de Dados
    • Comunicando com a API
    • Criando um CRUD
  • Gerenciando Permissões
  • Gerenciando Estado Global
    • Criando um estado global

• Formulários e Traduções

  • Trabalhando com Formulários
    • Criando um formulário
  • Internacionalização
    • Criando uma tradução

• Utilitários

  • Componentes do Projeto
  • Funções Globais e Hooks
    • Funções Globais
    • Hooks do projeto
  • Notificações e Diálogos
    • Utilizando Toast e Dialog

Roadmap

• Implantação i18n
• Componente para trocar idioma
• Lapidação das funções helper globais
• Sistema de funções de usuários
• Gerenciar dados CRUD com fácil implantação
• Área de perfil do usuário
• Documentação
• Suporte a testes unitários
• Suporte ao Laravel 9 e 10
• Suporte ao React 18
• Transformar em package