moox

Projeto Moox

Bem-vindo ao Projeto Moox. Este é um aplicativo Laravel Monorepo e instalável para desenvolver nossos Filament Plugins, também conhecidos como Laravel Packages. Estamos em um estágio inicial de desenvolvimento, mas já existem alguns plugins que você pode considerar úteis:

Pacotes

• Moox Skeleton, nosso pacote Skeleton para criar novos Filament Plugins
• Moox Builder, nosso pacote Builder para criar recursos de filamento
• Moox Core, exigido por todos os nossos pacotes, envia itens comuns
• Moox Jobs, gerencia filas de trabalhos, trabalhos com falha e lotes no filamento

Alguns estão em uso produtivo, mas ainda não documentados:

• Moox Expiry, defina e automatize a expiração de seus registros
• Moox User Device, gerencie os dispositivos de seus usuários e decida como lidar com desconhecidos
• Sessão de usuário Moox, gerencie a sessão de seus usuários (também no contexto de dispositivos)

Todos os outros pacotes estão em forte desenvolvimento:

• Auditoria Moox, registro e auditoria, relacionada à segurança e ao modelo
• Moox Flags, Flags contém ícones de lâmina para países, idiomas e muito mais
• Moox Localize, países, idiomas, moedas, prefixos de países, fusos horários
• Link de login Moox, envie links de login (também conhecidos como links mágicos) para seus usuários
• Moox Page, gerenciamento de conteúdo, atualmente abandonado porque usamos Press
• Moox Passkey, oferece aos usuários a capacidade de usar chaves de acesso (Webauthn)
• Permissão Moox, gerencie funções e permissões usando Spatie Permission
• Moox Press, use WordPress sem usar WordPress, em Filament
• Modelo Moox Redis, use Redis como substituto de plug-in para seus modelos
• Moox Security, gerencie a segurança de sua senha e outros recursos de segurança
• Moox Sync, sincronize registros de servidor para servidor, adicione lógica e transformadores
• Moox Trainings, automatiza treinamentos, convites e autovalidação
• Usuário Moox, gerencie seus usuários no Filament e conceda aos usuários acesso aos seus perfis

E há outras coisas que NÃO estão neste repositório:

• Moox DevOps, gerencie seus servidores, sites e implantações Forge
• UI do servidor de backup Moox, UI de filamento para servidor de backup Spatie Laravel
• Moox VS Code Extensions, nosso pacote de extensão de código VS para desenvolvedores de Filament

Instalação

O aplicativo Laravel dev na pasta raiz do Moox Monorepo é feito para desenvolvimento instantâneo com Laravel Herd, Laravel Valet, Laravel Sail ou Laragon.

 # Create a .env file and adjust to your needs
cp .env.example .env

# Don't forget to create the database according .env

# Install via Composer
composer install

# Migrate and seed
php artisan migrate:fresh --seed

# Use Vite (for Laravel Sail on Windows: do it in Ubuntu, not inside the Sail container)
npm install
npm run dev

Coisas opcionais:

 # You can create a user then
php artisan make:filament-user

# You can use the custom composer.json
cp _custom/composer.json-example _custom/composer.json

# Run Sail (alternatively start Herd,Laragon or Valet)
./vendor/bin/sail up

# Rebuild the sail config if needed
./vendor/bin/sail down --rmi all -v
php artisan sail:install

# Remove broken symlinks if needed
# switching from Laragon to Sail for example
rm -Rf vendor/mooxphp

O Moox Admin agora está disponível em /moox, por exemplo, https://moox.test/moox

Imprensa Moox

Para instalar o Moox Press, você precisa de um WordPress rodando em /public/wp (ou outro subdiretório, configurado em .env).

Instale um novo WordPress

Para instalar um WordPress novo, fornecemos um comando artesão, fornecido com o pacote Moox Press:

php artisan mooxpress:wpinstall

O comando precisa de alguma otimização e roda apenas “metade” no Windows.

Pacotes personalizados

Nosso Monorepo está preparado para ser um agente duplo:

• Desenvolva um projeto privado ou público
• ao contribuir para o projeto Moox

Isso é feito oferecendo suporte a pacotes personalizados no aplicativo de desenvolvimento do nosso Monorepo. Parece interessante? Leia em _custom/README.md.

Desenvolvimento

• Faça npm run build antes de confirmar porque os testes automatizados no GitHub precisam de um manifesto funcional
• Faça php artisan migrate --database=sqlite para refletir as alterações no banco de dados de teste
• Use https://marketplace.visualstudio.com/items?itemName=adrolli.tallui-laravel-livewire-tailwind com código VS
• Use https://github.com/mooxphp/builder para criar seus próprios pacotes
• Consulte CONTRIBUINDO para obter detalhes.

Ramificação

• main é a versão estável atual, protegida por branch, com commit automático para todos os pacotes, implantada em li
• feature/... prefixe todos os feature-branches, crie suas solicitações pull diretamente para main

Use ramificações baseadas em problemas, prefixe-as com feature/ (por exemplo, feature/38-welcome-view) para testes automatizados e análise de código.

Confirmações

Suas mensagens de commit serão mescladas em Changelog.md, o que significa que elas se tornarão parte da documentação. Por favor, certifique-se, você

• comece com um desses tipos
  • Bump = mudança secundária de versão, maior se usado como Bump!
  • Limpar = excluir coisas antigas ou código não utilizado
  • Deps = alterando dependências
  • Devops = GH e automação
  • Documentos = documentação
  • Talento = recurso
  • Correção = correção de bug
  • Lang = tradução
  • Testes = testes de escrita
  • Wip = trabalho em andamento
• para alterações significativas, adicione "!" para qualquer tipo para criar um lançamento importante
• seguido pelo nome abreviado do pacote, em []
  • Todos - vários ou todos os pacotes
  • Repo - coisas Monorepo
  • Essencial
  • Construtor
  • Empregos
  • ...
• faça referência a um problema, vinculado pelo número do problema, por exemplo, #138
• prepare o fechamento automático do problema usando "Close #138"

Exemplos válidos

• Wip[Core]: Feature register assets wip #123
• Fix[All]: Update all packages Close #321
• Feat[Monorepo]: Update dev app Close #22
• Bump![ChartComponents]: Major Updates
• Feat![PackageBuilder]: This will become a major release #23

Leia mais sobre commits convencionais.

Solicitações pull

Crie um PR para main . Use commits convencionais como explicado acima.

Sempre

Usamos versionamento semântico, escrito como 1.2.3 para

1. Principais lançamentos
2. Lançamentos menores
3. Versões de correção de bugs

Visite Semver.org para obter mais informações.

Lançamentos

Atualmente feito manualmente, um recurso de liberação automática está a caminho.

Teste

Testamos Moox usando:

• Monorepo
  • Larastan, PHPStan Nível 5
  • Laravel Pint, fixador PHP CS
  • Codacy e clima de código
• Pacotes
  • Larastan, PHPStan Nível 5
  • Laravel Pint, fixador PHP CS
  • Praga

Certifique-se de usar as mesmas ferramentas no VS Code (nosso pacote de extensão do VS Code cobre isso) ou faça as verificações manualmente antes de confirmar com o dev-branch:

• PHPStan: composer analyse ou ./vendor/bin/phpstan analyse , para pacotes ../../vendor/bin/phpstan analyse
• Pragas: composer test ou ./vendor/bin/pest , para pacotes ../../vendor/bin/pest
• Cobertura: composer test-coverage ou ./vendor/bin/pest --coverage , para pacotes ../../vendor/bin/pest --coverage
• Pint: composer format ou ./vendor/bin/pint , para pacotes ../../vendor/bin/pint

Navegação administrativa

Os títulos e a classificação no AdminPanel podem ser ajustados nas configurações dos pacotes, mas esta é a classificação padrão que mantém tudo no lugar:

 - Dashboard
- Main - 1000
    - Expiry - 1100
    - Notifications - 1800
- Content - 2000
    - Posts - 2100
    - Pages - 2200
    - Media - 2300
    - Categories - 2400
    - Tags - 2500
    - Comments - 2600
- Custom - 3000
    - ...
- Meta - 4000
    - Wp Meta...
- Custom - 5000
    - ...
- Users - 6000
    - App users - 6010 (Moox Users, Moox Press Users 6015)
    - Site users - 6020
    - Customers - 6030
    - Registrations - 6100
    - Roles - 6200
    - Permissions - 6201
    - Devices - 6300
    - Sessions - 6400
    - Login-Links - 6500
    - Password-Tokens - 6600
    - Passkeys - 6700
- System - 7000
    - Audit - 7500
    - Options (Press) - 7900
- Jobs - 8000
    - Job manager - 8001
    - ...
- Tools - 9000
    - Sync - 9500
    - Backup - 9800
    - Builder - 9990

Colaboradores

Moox é feito por essas pessoas legais e bots...

Alf Drollinger ? ? ?️	Aziz Gasim ?️	KimSpeer ?️	Weblate (bot) ?	Bot Moox ?	Reinhold Jesse	FMorlock ? ?
Sam Bola ?	Kim Speer ?️ ️	Mudança Laravel ?	Mikagrich	somogyi.zoltan	Igor Clauss	Greg R.G.
Allan Nordhøy ?	Jana Brot	Milo Ivir ?	Mika	Todos os colaboradores ?	Freek Van der Herten ?	renovar[bot] ?
ações do github[bot] ?	dependebot[bot] ?	Mikachu	Simão	Kalpesh Mahida	Rowlin	Mark van den Broek
Sebastião De Deyne	Pedro Forret	Ettore Atalan ?	Paulo	Salh

Esta tabela é gerada pelo All Contributors Bot. Para adicionar contribuidores use o seguinte comando em qualquer comentário de um problema ou PR:

@all-contributors please add @github-user for code

Normalmente usamos “código” e “tradução”, mas existem outros tipos possíveis listados em AllContributers.org. Faça apenas uma solicitação por vez, pois poderemos enfrentar conflitos de mesclagem se você tentar adicionar vários colaboradores sem mesclar o PR entre eles.

Contribuir

Agradecemos todas as contribuições! Seria incrível se você:

• Crie um problema no repositório que melhor se adapte e adicione informações sobre o problema ou ideia. Responderemos dentro de alguns dias.
• Crie uma solicitação pull neste Monorepo. Por favor, não faça PR para nossos repositórios somente leitura, eles não estão preparados para alterações de código. Somente o monorepo possui portões de qualidade e testes automatizados.
• Traduza Moox usando Weblate.
• Conte a outras pessoas sobre o Moox ou crie um link para nós.
• Considere uma doação ou patrocínio.

Tradução

Moox é traduzido com Weblate. É claro que você também pode editar diretamente os arquivos de tradução nos pacotes, mas usar uma plataforma de tradução completa como o Weblate pode ser mais conveniente.

Licença

Moox é um software de código aberto gratuito licenciado sob a licença MIT.

Alguns dos projetos dos quais dependemos são lançados sob uma licença diferente. Fazemos o possível para garantir que essas licenças permitam o uso privado e comercial e não imponham quaisquer restrições.

Se você notar algum problema com o licenciamento do Moox ou qualquer dependência, envie-nos um email para [email protected].

Segurança

Conforme mencionado acima, usamos verificações automatizadas de código e auditorias de segurança para garantir que nosso código esteja livre de vulnerabilidades de segurança.

Leia nossa Política de Segurança para saber mais sobre segurança ou relatar uma possível vulnerabilidade. NÃO use o rastreador de problemas para relatar problemas relacionados à segurança.