Versão inicial do padrão digital de governo adaptado para Laravel

Author: Cristiano Lima

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

.env.example

@@ -0,0 +1,64 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_TIMEZONE=UTC
+APP_URL=http://localhost
+
+APP_LOCALE=pt_BR
+APP_FALLBACK_LOCALE=en
+APP_FAKER_LOCALE=en_US
+
+APP_MAINTENANCE_DRIVER=file
+# APP_MAINTENANCE_STORE=database
+
+BCRYPT_ROUNDS=12
+
+LOG_CHANNEL=stack
+LOG_STACK=single
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=sqlite
+# DB_HOST=127.0.0.1
+# DB_PORT=3306
+# DB_DATABASE=laravel
+# DB_USERNAME=root
+# DB_PASSWORD=
+
+SESSION_DRIVER=database
+SESSION_LIFETIME=120
+SESSION_ENCRYPT=false
+SESSION_PATH=/
+SESSION_DOMAIN=null
+
+BROADCAST_CONNECTION=log
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=database
+
+CACHE_STORE=database
+CACHE_PREFIX=
+
+MEMCACHED_HOST=127.0.0.1
+
+REDIS_CLIENT=phpredis
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=log
+MAIL_HOST=127.0.0.1
+MAIL_PORT=2525
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="hello@example.com"
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+VITE_APP_NAME="${APP_NAME}"

.gitattributes

@@ -0,0 +1,11 @@
+* text=auto eol=lf
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.github export-ignore
+CHANGELOG.md export-ignore
+.styleci.yml export-ignore

.gitignore

@@ -0,0 +1,21 @@
+/.phpunit.cache
+/node_modules
+/public/build
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+.env
+.env.backup
+.env.production
+.phpactor.json
+.phpunit.result.cache
+Homestead.json
+Homestead.yaml
+auth.json
+npm-debug.log
+yarn-error.log
+/.fleet
+/.idea
+/.vscode
+.DS_Store

README.md

@@ -0,0 +1,132 @@
+# Padrão Digital de Governo em Laravel
+
+Template CSS do [Padrão Digital de Governo](https://www.gov.br/ds/ 'Acesse a página do Padrão Digital de Governo') 
+adaptado para utilização no [Laravel](https://laravel.com/). A partir desse projeto é possível desenvolver uma aplicação 
+PHP com a interface oficial do governo sem nenhuma configuração adicional de CSS. As classes utilizadas devem ser as 
+mesmas presentes na [documentação oficial](https://www.gov.br/ds/home).  
+
+O [Padrão Digital de Governo](https://www.gov.br/ds/ 'Acesse a página do Padrão Digital de Governo') apresenta os 
+padrões de interface que devem ser seguidos por designers e desenvolvedores para garantir a experiência única na 
+interação dos usuários com os sistemas interativos do Governo Brasileiro. 
+
+## Estrutura de código
+
+![Laravel](https://img.shields.io/badge/Laravel%2011-FF2D20?style=for-the-badge&logo=laravel&logoColor=white "Laravel 11")
+![Alpine JS](https://img.shields.io/badge/Alpine%20JS-8BC0D0?style=for-the-badge&logo=alpinedotjs&logoColor=black "Alpine JS")
+![GOV.BR](https://img.shields.io/badge/GOV.BR-blue?style=for-the-badge&labelColor=%23333&color=%230C326F&link=https%3A%2F%2Fwww.gov.br%2Fds)<img src="https://kapowaz.github.io/square-flags/flags/br.svg" height="28" width="30"/>
+![Biblioteca de componentes compatível com a versão 3.5.2 do ds](https://img.shields.io/badge/vers%C3%A3o%203.5.2%20do%20ds-blue?style=for-the-badge&labelColor=%23333&color=%230C326F&link=https%3A%2F%2Fwww.gov.br%2Fds)
+
+- O ambiente BASE foi configurado com [LARAVEL SAIL](https://laravel.com/docs/11.x/sail) + [LARAVEL BREEZE](https://laravel.com/docs/11.x/starter-kits#laravel-breeze).
+- O CSS utilizado é o do padrão oficial do governo. Para mais detalhes, acesse a [documentação oficial](https://www.gov.br/ds/home).
+- De forma complementar, foi instalado o [laravel-pt-BR-localization](https://github.com/lucascudo/laravel-pt-BR-localization), que implementa a tradução do Laravel para PT-BR.
+
+## Capturas de tela
+
+### Login (Laravel Breeze)
+<kbd>![Tela de Login]( screenshots/1.png )</kbd>
+
+---
+
+### Registro de usuário (Laravel Breeze)
+<kbd>![Tela de ](screenshots/2.png)</kbd>
+---
+
+### Painel inicial
+<kbd>![Tela de ](screenshots/3.png)</kbd>
+
+---
+
+### Template base
+<kbd>![Tela de ](screenshots/4.png)</kbd>
+
+---
+
+### Menu lateral
+<kbd>![Tela de ](screenshots/5.png)</kbd>
+
+---
+
+### Perfil de usuário (Laravel Breeze)
+<kbd>![Tela de ](screenshots/6.png)</kbd>
+
+---
+
+## Instalação e primeiro acesso
+
+### Comandos essenciais para rodar
+
+##### 1 - Cria um alias para execurar o [Laravel Sail](https://laravel.com/docs/sail) de forma facilitada:
+```bash
+alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'
+```
+
+##### 2 - Instala dependências para execurar o [Laravel Sail](https://laravel.com/docs/sail):
+```bash
+docker run --rm \
+    -u "$(id -u):$(id -g)" \
+    -v "$(pwd):/var/www/html" \
+    -w /var/www/html \
+    laravelsail/php82-composer:latest \
+    composer install --ignore-platform-reqs
+```
+
+##### 3 - Instala dependências NPM:
+```bash
+npm install
+```
+
+##### 4 - Cria o arquivo '.env' a partir do arquivo exemplo:
+```bash
+cp .env.example .env
+```
+##### 5 - Após criar o arquivo '.env', é necessário configurar as variáveis `FORWARD_DB_PORT`, `DB_CONNECTION`, `DB_HOST`, `DB_PORT`, `DB_DATABASE`,`DB_USERNAME`, `DB_PASSWORD`. Sem essa configuração, o sistema não consegue se comunicar com o banco de dados.
+
+Exemplo de configuração:
+```php
+  FORWARD_DB_PORT=6543
+  DB_CONNECTION=pgsql
+  DB_HOST=pgsql
+  DB_PORT=5432
+  DB_DATABASE=teste
+  DB_USERNAME=teste
+  DB_PASSWORD=123456
+```
+##### 6 - Ainda no arquivo '.env', é necessário criar a variável `APP_PORT` e atribuir a ela o número da porta desejada para acesso do sistema no navegador.
+
+##### 6.1 - Exemplo de configuração:
+```php
+  APP_PORT=123
+  APP_URL=http://localhost:${APP_PORT}
+```
+
+No exemplo de configuração acima, o sistema estará disponível na seguinte URL:
+```php
+  http://localhost:123
+```
+##### 7 - Configura a `APP_KEY` do sistema. Por que isso é necessário? Mais detalhes [aqui](https://laravel.com/docs/encryption).
+
+```bash
+php artisan key:generate
+```
+
+##### 8 - Roda os serviços via [Laravel Sail](https://laravel.com/docs/sail), em modo "detached":
+```bash
+sail up -d
+```
+##### 9 - Roda todas as migrations do sistema para o Laravel Breeze funcionar. Por que isso é necessário? Mais detalhes [aqui](https://laravel.com/docs/migrations).
+```bash
+sail artisan migrate
+```
+
+##### 10 - Compila o CSS:
+```bash
+sail npm run build
+```
+
+##### 11 - Primeiro acesso
+
+No primeiro acesso é necessário cadastrar um usuário. Caso tenha configurado a variável a `APP_PORT` [conforme o exemplo indicado](#61---exemplo-de-configuração), é possível fazer o procedimento pelo link:
+
+```php
+  http://localhost:123/register
+```

app/Http/Controllers/Auth/AuthenticatedSessionController.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace App\Http\Controllers\Auth;
+
+use App\Http\Controllers\Controller;
+use App\Http\Requests\Auth\LoginRequest;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\View\View;
+
+class AuthenticatedSessionController extends Controller
+{
+    /**
+     * Display the login view.
+     */
+    public function create(): View
+    {
+        return view('auth.login');
+    }
+
+    /**
+     * Handle an incoming authentication request.
+     */
+    public function store(LoginRequest $request): RedirectResponse
+    {
+        $request->authenticate();
+
+        $request->session()->regenerate();
+
+        return redirect()->intended(route('dashboard', absolute: false));
+    }
+
+    /**
+     * Destroy an authenticated session.
+     */
+    public function destroy(Request $request): RedirectResponse
+    {
+        Auth::guard('web')->logout();
+
+        $request->session()->invalidate();
+
+        $request->session()->regenerateToken();
+
+        return redirect('/');
+    }
+}

app/Http/Controllers/Auth/ConfirmablePasswordController.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Http\Controllers\Auth;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Validation\ValidationException;
+use Illuminate\View\View;
+
+class ConfirmablePasswordController extends Controller
+{
+    /**
+     * Show the confirm password view.
+     */
+    public function show(): View
+    {
+        return view('auth.confirm-password');
+    }
+
+    /**
+     * Confirm the user's password.
+     */
+    public function store(Request $request): RedirectResponse
+    {
+        if (! Auth::guard('web')->validate([
+            'email' => $request->user()->email,
+            'password' => $request->password,
+        ])) {
+            throw ValidationException::withMessages([
+                'password' => __('auth.password'),
+            ]);
+        }
+
+        $request->session()->put('auth.password_confirmed_at', time());
+
+        return redirect()->intended(route('dashboard', absolute: false));
+    }
+}

app/Http/Controllers/Auth/EmailVerificationNotificationController.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Http\Controllers\Auth;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+
+class EmailVerificationNotificationController extends Controller
+{
+    /**
+     * Send a new email verification notification.
+     */
+    public function store(Request $request): RedirectResponse
+    {
+        if ($request->user()->hasVerifiedEmail()) {
+            return redirect()->intended(route('dashboard', absolute: false));
+        }
+
+        $request->user()->sendEmailVerificationNotification();
+
+        return back()->with('status', 'verification-link-sent');
+    }
+}

app/Http/Controllers/Auth/EmailVerificationPromptController.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Http\Controllers\Auth;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\RedirectResponse;
+use Illuminate\Http\Request;
+use Illuminate\View\View;
+
+class EmailVerificationPromptController extends Controller
+{
+    /**
+     * Display the email verification prompt.
+     */
+    public function __invoke(Request $request): RedirectResponse|View
+    {
+        return $request->user()->hasVerifiedEmail()
+                    ? redirect()->intended(route('dashboard', absolute: false))
+                    : view('auth.verify-email');
+    }
+}