Skip to content

README-pt.md

Latest commit

 

History

History
379 lines (274 loc) · 11.6 KB

README-pt.md

File metadata and controls

379 lines (274 loc) · 11.6 KB

PivotPHP Banner

O Ecossistema PHP Evolutivo

Construindo ferramentas que se adaptam aos desenvolvedores, não o contrário.

Inglês Português GitHub followers

⚡ Benchmarks de Alta Performance | 🚀 Sintaxe Express.js | 🧪 Desenvolvimento Ativo | 🔬 Projeto de Pesquisa

🎯 Nossa Missão

Tornar o desenvolvimento PHP alegre novamente.

Depois de anos lutando com frameworks pesados e arquiteturas rígidas, acreditamos que os desenvolvedores PHP merecem algo melhor. PivotPHP é um framework experimental explorando padrões inspirados no Express.js em PHP.

🧪 Status do Projeto: PivotPHP é um projeto de pesquisa e desenvolvimento. Perfeito para prototipagem, aprendizado e validação de conceitos de API. Atualmente não recomendado para uso em produção.

Estamos construindo um ecossistema onde:

  • ⚡ Performance vem primeiro, não como repensamento
  • 🔧 Flexibilidade é o padrão, não um recurso premium
  • 💖 Experiência do desenvolvedor importa, do primeiro composer require ao deploy em produção
  • 🌱 Evolução é incentivada, deixando seu código crescer naturalmente

🤔 Por que PivotPHP?

🚀 APIs de Performance Excepcional

  • 2.122 req/seg pico HTTP (Docker v1.2.0)
  • 1.418 req/seg performance HTTP média
  • 3,6M ops/seg geração OpenAPI
  • Suporte a Array Callable (PHP 8.4+)
  • Benchmarks Docker validados

🎯 Desenvolvedor em Primeiro Lugar

  • Simplicidade tipo Express.js
  • Zero configuração
  • Design de API intuitivo

🧪 Ideal para Prototipagem

  • Desenvolvimento rápido de API
  • Validação rápida de conceitos
  • Tempo mínimo de configuração

Estamos construindo um ecossistema onde:

  • ⚡ Performance vem primeiro, não como repensamento
  • 🔧 Flexibilidade é o padrão, não um recurso premium
  • 💝 Experiência do desenvolvedor importa, do primeiro composer require ao deploy em produção
  • 🌱 Evolução é incentivada, deixando seu código crescer naturalmente

🌐 Nosso Ecossistema

Framework Core & Extensões Oficiais

💎 Framework Core

pivotphp-core O coração do PivotPHP. Microframework rápido e sem opiniões com sintaxe inspirada no Express.js.

// 🚀 Construa APIs em segundos
$app = new Application();

$app->get('/ola/:nome', fn($req, $res) =>
    $res->json(['mensagem' => "Olá, {$req->params->nome}!"])
);

$app->run(); // É isso! Zero boilerplate

Recursos:

  • Roteamento inspirado no Express.js
  • Compatível com PSR-7/PSR-15
  • Middleware de segurança integrado
  • Autenticação JWT & API Key
  • v1.2.0: Edição Simplicidade - "Simplicidade sobre Otimização Prematura"

🗄️ Extensão Cycle ORM

pivotphp-cycle-orm composer require pivotphp/cycle-orm

Integração poderosa de ORM com banco de dados com zero configuração.

// 🔍 Conexão em uma linha, consultas type-safe
$app->register(new CycleServiceProvider([
    'dbal' => ['databases' => ['default' => [
        'connection' => 'mysql://user:pass@localhost/db'
    ]]]
]));

$usuarios = Usuario::where('ativo', true)
    ->with('posts')
    ->limit(10)
    ->get(); // Otimização automática de queries

Recursos:

  • Migrações automáticas
  • Gerenciamento de relacionamentos
  • Suporte a transações
  • Múltiplas conexões de banco

⚡ Extensão ReactPHP

pivotphp-reactphp composer require pivotphp/reactphp

Runtime assíncrono para aplicações de longa duração.

// 🔄 Servidor contínuo sem reinicializações
$app->register(new ReactServiceProvider([
    'server' => ['host' => '0.0.0.0', 'port' => 8080]
]));

$app->runAsync(); // Event loop não-bloqueante

Recursos:

  • Arquitetura orientada a eventos
  • Suporte WebSocket (em breve)
  • Operações I/O assíncronas
  • Timer e tarefas periódicas

📍 Core Routing

pivotphp-core-routing

Roteamento modular extraído do core para flexibilidade máxima.

Recursos:

  • Express.js-Inspired API: Familiar routing patterns (get(), post(), put(), delete(), etc.)
  • High Performance: Multi-level caching, route indexing, and memory optimization
  • PSR Compliant: Full PSR-7 (HTTP), PSR-15 (Middleware), PSR-6/PSR-16 (Cache) support
  • Plugin System: Extensible architecture with built-in plugins
  • File Caching: Persistent route compilation for faster startup
  • Static File Serving: Express-style static file management
  • Type Safety: Strict typing with PHPStan Level 9 compliance
  • Modular: Use independently or integrate with PivotPHP Core

Extensões da Comunidade

Recursos Integrados na v1.2.0:

  • 📝 OpenAPI/Swagger Automático - Documentação API sem configuração
  • 🎯 Interface Swagger UI Interativa - Testes de API em /swagger
  • 🔄 15+ Aliases Automáticos - Zero breaking changes garantidos
  • 🎓 Arquitetura Educacional - Classes simples sobre complexas

Criando Sua Própria Extensão

// 1. Crie o Service Provider
class MyExtensionServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->container->singleton('myservice', MyService::class);
    }

    public function boot(): void
    {
        $this->app->get('/my-route', [MyController::class, 'handle']);
    }
}

// 2. Registre em sua app
$app->register(new MyExtensionServiceProvider());

Diretrizes para Extensões:

  • Siga a convenção de nomes pivotphp-{nome}
  • Forneça testes abrangentes
  • Documente com exemplos
  • Marque como pivotphp-extension no Packagist

📊 Pelos Números

Métrica Valor
HTTP Pico 2.122 req/seg (Docker v1.2.0)
Geração OpenAPI 3,6M ops/seg (Swagger UI)
HTTP Média 1.418 req/seg
Uso de Memória ~17.5MB (todas operações)
Extensões Core + ORM + ReactPHP
Status Pesquisa & Desenvolvimento

🔥 Construído para PHP Moderno

// 🔒 API segura com autenticação JWT em 5 linhas
$app->group('/api/v1', function($group) {
    $group->middleware([Auth::jwt(), RateLimit::perMinute(100)]);
    $group->get('/perfil', fn($req, $res) => $res->json($req->user));
    $group->resource('/posts', PostController::class);
});

// ✅ Validação type-safe pronta para usar
$dados = $req->validate([
    'email' => 'required|email',
    'nome' => 'required|string|max:100'
]);

// 🔌 Recursos em tempo real em 2 linhas
$ws = new WebSocket\Server($app);
$ws->on('message', fn($socket, $dados) => $socket->broadcast('update', $dados));

🚀 Começando

👨‍💻 Início Rápido (60 segundos)

# Crie sua primeira app PivotPHP
composer create-project pivotphp/skeleton minha-api
cd minha-api && php -S localhost:8000

# 🎉 Sua API está rodando em http://localhost:8000

🤝 Para Contribuidores

# Junte-se ao desenvolvimento
git clone https://github.com/pivotphp/pivotphp-core.git
cd pivotphp-core
composer install && composer test

🤝 Comunidade

Junte-se a milhares de desenvolvedores construindo o futuro do PHP

GitHub Discussions

Como Contribuir

Acreditamos que grandes softwares vêm de grandes comunidades. Veja como você pode ajudar:

  • Reporte bugs e solicite recursos em nossas Issues
  • Submeta código via Pull Requests em qualquer um dos nossos repositórios
  • Melhore docs editando nosso website
  • Ajude outros Discussions
  • Espalhe a palavra dando estrela nos repos e compartilhando com amigos

💡 Filosofia

🌱 Design Evolutivo

Como DNA que se adapta a diferentes ambientes, o PivotPHP evolui com seu projeto. Comece simples, escale complexo, nunca reescreva.

⚡ Performance Primeiro

Cada linha de código é otimizada. Medimos tudo e tornamos a performance visível, porque APIs rápidas fazem usuários felizes.

💝 Felicidade do Desenvolvedor

O melhor framework é aquele que você não pensa sobre. PivotPHP sai do seu caminho enquanto fornece as ferramentas que você precisa.

🤝 Dirigido pela Comunidade

Construído por desenvolvedores, para desenvolvedores. Cada decisão é feita pensando no uso do mundo real, não em ideais acadêmicos.

🗺️ Roadmap

Foco Atual (Q3 2025)
  • Estabilização do framework core ✅
  • Integração com Cycle ORM v1.0.1 ✅
  • Extensão ReactPHP v0.1.0 ✅
  • Suite de benchmarking de performance ✅
  • OpenAPI/Swagger integração v1.2.0 ✅
  • Interface de documentação interativa ✅
  • Arquitetura educacional simplificada ✅
  • Sistema de zero breaking changes ✅
Em Breve (Q4 2025)

Extensões da Comunidade:

  • Integração WebSocket para extensão ReactPHP
  • Coleção aprimorada de middlewares
  • Utilitários e helpers de testes

Ferramentas do Desenvolvedor:

  • Containers Docker de desenvolvimento
  • Extensão VS Code com snippets
  • Plugin PHPStorm
  • Guias de deployment (Heroku, AWS, DigitalOcean)
Visão Futura (2026)

Extensões de Pesquisa:

  • Monitoramento de performance aprimorado
  • Padrões avançados de middleware
  • Recursos estendidos de compliance PSR

Visão de Longo Prazo:

  • Estabilização do framework para uso em produção
  • Documentação e exemplos estendidos
  • Desenvolvimento dirigido pela comunidade
  • Recursos educacionais e tutoriais

👨‍💻 Sobre o Criador

Caio Alberto Fernandes começou o PivotPHP após 6 anos de frustração com frameworks PHP existentes. O que começou como um experimento de fim de semana para trazer a elegância do Express.js para o PHP cresceu e virou um movimento por melhores ferramentas para desenvolvedores.

"Acredito que os melhores frameworks são invisíveis—eles amplificam suas habilidades sem impor suas opiniões. PivotPHP é minha tentativa de construir essa camada invisível para desenvolvedores PHP."

📜 Licença & Suporte

  • Licença: MIT (livre para uso comercial)
  • Suporte: Dirigido pela comunidade via GitHub
  • Patrocínio: GitHub Sponsors

⭐ Dê estrela nos nossos repositórios para mostrar seu apoio!

💎 Framework Core • 🗄️ Cycle ORM • 📚 Website • 🎓 Exemplos

Feito com amor pela comunidade PHP, para a comunidade PHP.

PivotPHP: Código que evolui com você.