README

A premium, single-page database viewer for Laravel 11+, PHP 8.2+, using Inertia.js 2.0 and Vue.js with Tailwind CSS.

Features

🚀 Single Page Application: Powered by Inertia.js 2.0 for a seamless experience.
🎨 Modern UI: Fully redesigned with Tailwind CSS and dark-mode aesthetics.
📊 Table Exploration: Instant access to all tables in your database.
📄 Data Grid: Browse table data with high-performance pagination.
🛠 Future Ready: Optimized for PHP 8.3, 8.4 and Laravel 11.
🛠 Easy Integration: Zero-config setup for modern Laravel projects.

Installation

You can install the package via composer:

composer require httpsnader1/database-viewer:dev-master -W

Note: Since this is a local package or not yet on Packagist, you can add it to your composer.json repositories:

"repositories": [
    {
        "type": "path",
        "url": "../path-to-this-package"
    }
]

Setup

Publish Assets: You need to publish the Vue components to your resources folder so your Vite can compile them.

php artisan vendor:publish --tag="database-viewer-assets"

This will copy the components to resources/js/vendor/database-viewer.

Register Components: In your app.js (Inertia setup), make sure you are resolving components from the vendor directory as well.

Example resources/js/app.js:

resolve: (name) => {
    // Check if it's a vendor component
    if (name.startsWith('DatabaseViewer/')) {
        return resolvePageComponent(`./vendor/database-viewer/Pages/${name}.vue`, import.meta.glob('./vendor/database-viewer/Pages/**/*.vue'));
    }
    return resolvePageComponent(`./Pages/${name}.vue`, import.meta.glob('./Pages/**/*.vue'));
},

Usage

Once installed and set up, you can access the database viewer at:

your-app.test/database-viewer

Security Warning

This package is intended for development purposes. DO NOT use it in production as it exposes your entire database structure and data. Always wrap the routes in a middleware that checks for administrator privileges.

You can override the routes by defining them in your web.php if you need custom middleware:

Route::prefix('admin/database')->middleware(['auth', 'can:view-database'])->group(function () {
    // ... custom routes
});

License

The MIT License (MIT).

httpsnader1 / database-viewer

Maintainers

Package info

Statistics

Security