laravel-finance

laravel-finance é uma bilioteca genérica para o laravel. É um exemplo de uma Lib que possui rotas próprias, controllers, models, migrations, FormRequests, resources, arquivos de tradução, views (integração do blade do laravel com vue.js)

Getting Started

Add in composer.json:

"repositories": [
    {
        "type": "vcs",
        "url": "https://libs:[email protected]/laravel-libs/laravel-finance.git"
    }
]

require:{
        "codificar/finance": "1.2.4",
}

"autoload": {
    "psr-4": {
        "Codificar\\Finance\\": "vendor/codificar/finance/src/"
    }
}

Update project dependencies:

$ composer update

Register the service provider in config/app.php:

'providers' => [
  /*
   * Package Service Providers...
   */
  Codificar\Finance\FinanceServiceProvider::class,
],

Check if has the laravel publishes in composer.json with public_vuejs_libs tag:

    "scripts": {
        //...
		"post-autoload-dump": [
			"@php artisan vendor:publish --tag=public_vuejs_libs --force"
		]
	},

Or publish by yourself

Publish Js Libs and Tests:

$ php artisan vendor:publish --tag=public_vuejs_libs --force

• Migrate the database tables

php artisan migrate

Observações

• É importante sempre especificar qual middleware a biblioteca que você for desenvolver utiliza. Tais middleware deverão ser pré requisitos para os projetos que for instalar a sua lib. Exemplo: middleware para verificar se o admin fez login 'middleware' => 'auth.admin_api'
• Utilizar preferencialmente os models criados na bibliotecas. Se utilizar models de um projeto especifíco, outro projeto pode não conter os mesmos models.
• Arquivos de traduções também devem ser feitos na biblioteca (evitar utilizar traduções de um projeto)
• Utilizar os seguintes prefixos nas rotas: -- Rotas de api para apps: localhost:8000/libs/nomedarota -- Rotas do painel : localhost:8000/admin/libs/nomedarota, e localhost:8000/corp/libs/nomedarota ...
• Preferencialmente, ao criar migrations, verificar se uma coluna, tabela ou row, já existe. Somente se não existir deverá ser criado.
• Deverá ser instalado o vue.js dentro da biblioteca
• Gerar os arquivos minificados do vue dentro da própria biblioteca do laravel, e utilizar o publishes do laravel para colocar esses arquivos dentro da pasta public do projeto que for instalar essa lib. Depois é só adicionar o script no composer.json para quando rodar o comando composer dump-autoload -o, ele roda o publishes e copia esses arquivos minificados do vue da bilioteca e jogo dentro do projeto. É importante ficar atento ao tamanho do arquivo, evite utilizar modulos desnecessários no package.json e no fim, quando for da commit nas suas mudanças, rode npm run prod para gerar os arquivos minificados.
• Repare no arquivo FinanceServiceProvider.php:

$this->publishes([
    __DIR__.'/../public/js' => public_path('vendor/codificar/finance'),
], 'public_vuejs_libs'); 

• Aqui está sendo copiado os arquivos da pasta public/js da biblioteca e jogado para a pasta public/vendor/codificar/finance do projeto
• Abaixo, na parte de instalação, será mostrado como colocar o script no composer.json do projeto para fazer as mudanças sempre que rodar composer dump-autoload -o

Rotas

Tipo	Retorno	Rota	Description
get	View/html	/admin/libs/example_vuejs	Api retorna um exemplo de uma página feita em vue.js
get	Api/json	/libs/finance/example	Api que os Apps poderão consumir
get	Api/json	/libs/finance/lang.trans/{file}	Api retornará os arquivos de tradução do Laravel para serem usados dentro do vue.js

Estrutura