Merge pull request #6 from TappNetwork/add_route_test_update_readme

Add route test update readme

Author: andreia

README.md

@@ -3,6 +3,11 @@
     <img alt="Tapp Laravel 12 Starter Kit Light Logo" src="https://raw.githubusercontent.com/TappNetwork/laravel-starter-kit/main/art/logo_light.png">
 </picture>
 
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/tapp/laravel-starter-kit.svg?style=flat-square&colorA=3d454d&colorB=2a7de1)](https://packagist.org/packages/tapp/laravel-starter-kit)
+![GitHub Tests Action Status](https://github.com/TappNetwork/laravel-starter-kit/actions/workflows/test.yml/badge.svg?style=flat-square)
+![GitHub Pint Action Status](https://github.com/TappNetwork/laravel-starter-kit/actions/workflows/pint.yml/badge.svg?style=flat-square)
+[![Total Downloads](https://img.shields.io/packagist/dt/tapp/laravel-starter-kit.svg?style=flat-square&colorA=3d454d&colorB=2a7de1)](https://packagist.org/packages/tapp/laravel-starter-kit)
+
 # Tapp Laravel 12 Starter Kit
 
 Key features include:
@@ -49,24 +54,22 @@ While TailwindCSS and Alpine.js are included for styling and frontend interactiv
 ## Quick Start
 
 ```bash
-composer create-project tapp/laravel-starter-kit
+composer create-project tapp/laravel-starter-kit <your-project-name-here>
 ```
 
 Install dependencies
 
 ```bash
-composer install
-
 npm install
 npm run build
 ```
 
-Setup environment
+Setup the environment
 
-```bash
-cp .env.example .env
+In the `.env` file, update the database name and other env vars according to your needs:
 
-# in the newly created .env file, configure your database:
+```bash
+# in the .env file, configure your database:
 
 DB_CONNECTION=mysql
 DB_HOST=127.0.0.1

public/images/og.jpg

@@ -0,0 +1,89 @@
+<?php
+
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Support\Facades\Route;
+
+uses(RefreshDatabase::class);
+
+beforeEach(function () {
+    $this->seed();
+});
+
+// Helper functions to get routes
+function getGuestRoutes()
+{
+    $rejectRoutes = [
+        'pulse',
+        'auth/google',
+        'user/confirm-password',
+        'user/confirmed-password-status',
+        'two-factor-challenge',
+        'user/two-factor-qr-code',
+        'user/two-factor-secret-key',
+        'user/two-factor-recovery-codes',
+        'livewire/livewire.min.js',
+    ];
+
+    $rejectFrontendRoutes = [
+        '/',
+    ];
+
+    $frontendRoutes = [
+    ];
+
+    return collect(Route::getRoutes())
+        ->filter(fn ($route) => in_array('GET', $route->methods()))
+        ->reject(fn ($route) => in_array('auth', $route->gatherMiddleware()))
+        ->reject(fn ($route) => in_array($route->uri(), ['sanctum/csrf-cookie', '_ignition/health-check', 'api/user']))
+        ->reject(fn ($route) => str_contains($route->uri(), 'admin'))
+        ->reject(fn ($route) => in_array($route->uri(), $frontendRoutes))
+        ->reject(fn ($route) => in_array($route->uri(), $rejectRoutes))
+        ->reject(fn ($route) => in_array($route->uri(), $rejectFrontendRoutes))
+        ->reject(fn ($route) => str_contains($route->uri(), '{'))
+        ->reject(fn ($route) => str_contains($route->uri(), 'debug'))
+        ->map(fn ($route) => $route->uri())
+        ->values()
+        ->toArray();
+}
+
+function getFrontendRoutes()
+{
+    $frontendRoutes = [
+    ];
+
+    $rejectFrontendRoutes = [
+        '/',
+    ];
+
+    return collect(Route::getRoutes())
+        ->filter(fn ($route) => in_array('GET', $route->methods()))
+        ->reject(fn ($route) => in_array($route->uri(), ['sanctum/csrf-cookie', '_ignition/health-check', 'api/user']))
+        ->reject(fn ($route) => str_contains($route->uri(), 'admin'))
+        ->filter(fn ($route) => in_array($route->uri(), $frontendRoutes))
+        ->reject(fn ($route) => in_array($route->uri(), $rejectFrontendRoutes))
+        ->reject(fn ($route) => str_contains($route->uri(), '{'))
+        ->reject(fn ($route) => str_contains($route->uri(), 'create'))
+        ->reject(fn ($route) => str_contains($route->uri(), 'debug'))
+        ->map(fn ($route) => $route->uri())
+        ->values()
+        ->toArray();
+}
+
+it('can render all guest routes', function () {
+    $routes = getGuestRoutes();
+
+    foreach ($routes as $url) {
+        $this->get($url)->assertOk();
+    }
+});
+
+it('can render all frontend routes', function () {
+    $this->actingAs(User::where('email', 'admin@dev.com')->first());
+
+    $routes = getFrontendRoutes();
+
+    foreach ($routes as $url) {
+        $this->get($url)->assertOk();
+    }
+});

tests/Feature/RouteTest.php

@@ -15,6 +15,10 @@
 // pest()->extend(Tests\TestCase::class)
 //     ->in('Feature', 'Unit');
 
+uses(
+    Tests\TestCase::class
+)->in('.');
+
 /*
 |--------------------------------------------------------------------------
 | Expectations

tests/Pest.php

@@ -5,9 +5,8 @@
 use Illuminate\Support\Facades\Hash;
 use Spatie\Permission\Models\Permission;
 use Spatie\Permission\Models\Role;
-use Tests\TestCase;
 
-uses(TestCase::class, RefreshDatabase::class);
+uses(RefreshDatabase::class);
 
 test('user can be created', function () {
     $user = User::factory()->create([