PHPackages                             sierratecnologia/escritor - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. sierratecnologia/escritor

ActiveLibrary

sierratecnologia/escritor
=========================

escritor

0.4.4(2y ago)00MITPHPPHP ^7.2|^8.0CI failing

Since Jul 17Pushed 6mo ago1 watchersCompare

[ Source](https://github.com/SierraTecnologia/Escriba)[ Packagist](https://packagist.org/packages/sierratecnologia/escritor)[ Docs](https://sierratecnologia.com/packages/escritor/)[ Fund](https://ricasolucoes.com.br/open-source/support-us)[ GitHub Sponsors](https://github.com/ricasolucoes)[ RSS](/packages/sierratecnologia-escritor/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (9)Versions (6)Used By (0)

SierraTecnologia Escritor
=========================

[](#sierratecnologia-escritor)

**SierraTecnologia Escritor** integration services escritor and providers for users required by various SierraTecnologia packages. Validator functionality, and basic controller included out-of-the-box.

[![Packagist](https://camo.githubusercontent.com/9a7bc25f03300734fd6aa1c376a1f5f2d922064f1d42719781aceb8c1bd7a6d8/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7369657272617465636e6f6c6f6769612f6573637269746f722e7376673f6c6162656c3d5061636b6167697374267374796c653d666c61742d737175617265)](https://packagist.org/packages/sierratecnologia/escritor)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/106e150b4dd2e64ba740b49902dd7d45fc162b028bb540dc2238a2328d7ddd21/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f7369657272617465636e6f6c6f6769612f6573637269746f722e7376673f6c6162656c3d5363727574696e697a6572267374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/sierratecnologia/escritor/)[![Travis](https://camo.githubusercontent.com/401b33719e6902422787341d91008887be0eef4a3b8812840099eaba10f10b69/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f7369657272617465636e6f6c6f6769612f6573637269746f722e7376673f6c6162656c3d5472617669734349267374796c653d666c61742d737175617265)](https://travis-ci.org/sierratecnologia/escritor)[![StyleCI](https://camo.githubusercontent.com/4191b35d1ee7b0da2e27c1fe2bd612ce3dfe1673a64523a762f99155892e2142/68747470733a2f2f7374796c6563692e696f2f7265706f732f36303936383838302f736869656c64)](https://styleci.io/repos/60968880)[![License](https://camo.githubusercontent.com/aaf5a9a555dbf40abcd5a07f6e18041db286b7653c6455e371aa898d4abb99db/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f7369657272617465636e6f6c6f6769612f6573637269746f722e7376673f6c6162656c3d4c6963656e7365267374796c653d666c61742d737175617265)](https://github.com/sierratecnologia/escritor/blob/master/LICENSE)

📚 Índice
--------

[](#-índice)

- [Introdução](#-introdu%C3%A7%C3%A3o)
- [Instalação](#-instala%C3%A7%C3%A3o)
- [Arquitetura e Estrutura Interna](#-arquitetura-e-estrutura-interna)
- [Principais Funcionalidades](#-principais-funcionalidades)
- [Uso Prático](#-uso-pr%C3%A1tico)
- [Integração com o Ecossistema SierraTecnologia](#-integra%C3%A7%C3%A3o-com-o-ecossistema-sierratecnologia)
- [Extensão e Customização](#-extens%C3%A3o-e-customiza%C3%A7%C3%A3o)
- [Exemplos Reais](#-exemplos-reais)
- [Guia de Contribuição](#-guia-de-contribui%C3%A7%C3%A3o)
- [Ferramentas de Qualidade (GitHub Tools)](#-ferramentas-de-qualidade-github-tools)

🎯 Introdução
------------

[](#-introdução)

### O que é o Escriba

[](#o-que-é-o-escriba)

O **Escriba** (também conhecido como **Escritor**) é um módulo completo de e-commerce e gestão comercial desenvolvido pela **SierraTecnologia**, projetado para integrar funcionalidades robustas de loja virtual, gestão de produtos, processamento de pedidos e transações financeiras em aplicações Laravel.

### Objetivo e Motivação

[](#objetivo-e-motivação)

O projeto nasceu da necessidade de fornecer uma solução empresarial completa e modular para PMEs, permitindo:

- **Gestão completa de produtos** com variantes, imagens e arquivos digitais
- **Carrinho de compras** inteligente com gestão de sessão
- **Processamento de pedidos** e controle de estoque
- **Sistema de transações** financeiras integrado
- **Planos de assinatura** (subscriptions) opcionais
- **Cupons de desconto** e promoções
- **Analytics** e relatórios de vendas
- **Favoritos** e listas de desejos

### Contexto no Ecossistema SierraTecnologia / Rica Soluções

[](#contexto-no-ecossistema-sierratecnologia--rica-soluções)

O Escriba é um componente fundamental do ecossistema **SierraTecnologia**, atuando como camada comercial para diversos produtos e serviços da **Rica Soluções**. Ele integra-se nativamente com:

- **Pedreiro** - Fundação e estruturas base
- **Muleta** - Helpers e utilitários
- **Crypto** - Criptografia e segurança
- **MediaManager** - Gestão de arquivos e imagens
- **Porteiro** - Autenticação e autorização
- **Facilitador** - Automações e integrações

### Benefícios no Gerenciamento Comercial

[](#benefícios-no-gerenciamento-comercial)

- ✅ **Modularidade**: Arquitetura desacoplada e extensível
- ✅ **Integração Nativa**: Funciona perfeitamente com Laravel e o ecossistema SierraTecnologia
- ✅ **Escalabilidade**: Preparado para alta demanda e múltiplos canais de venda
- ✅ **Flexibilidade**: Suporte a produtos físicos, digitais e assinaturas
- ✅ **Analytics**: Dashboards e relatórios prontos para uso
- ✅ **Multi-tenant**: Suporte opcional para múltiplas lojas

📦 Instalação
------------

[](#-instalação)

### Requisitos Mínimos

[](#requisitos-mínimos)

- **PHP**: ^8.0 (recomendado 8.2+)
- **Laravel**: ^9.0 | ^10.0 | ^11.0
- **Extensões PHP**: `mbstring`, `xml`, `bcmath`, `pdo`, `gd`, `fileinfo`
- **Dependências**:
    - `sierratecnologia/pedreiro`
    - `sierratecnologia/muleta`
    - `sierratecnologia/crypto`

### Instalação via Composer

[](#instalação-via-composer)

```
composer require sierratecnologia/escriba
```

### Publicação de Arquivos de Configuração

[](#publicação-de-arquivos-de-configuração)

Após a instalação, publique os arquivos de configuração, migrations e assets:

```
# Publicar configurações
php artisan vendor:publish --provider="Escritor\EscritorProvider" --tag=config

# Publicar views (opcional)
php artisan vendor:publish --provider="Escritor\EscritorProvider" --tag=views

# Publicar assets (opcional)
php artisan vendor:publish --provider="Escritor\EscritorProvider" --tag=public

# Executar migrations
php artisan migrate
```

### Registro Automático de Service Providers

[](#registro-automático-de-service-providers)

O **Service Provider** é registrado automaticamente via Laravel Package Auto-Discovery. Caso necessário registrar manualmente, adicione ao `config/app.php`:

```
'providers' => [
    // ...
    Escritor\EscritorProvider::class,
],

'aliases' => [
    // ...
    'Escritor' => Escritor\Facades\Escritor::class,
    'StoreHelper' => Escritor\Facades\StoreHelper::class,
],
```

### Configuração Básica

[](#configuração-básica)

Edite o arquivo `config/sitec/escritor.php`:

```