lagdo/polr-admin

A dashboard for the Polr URL shortener.

v0.2-beta1 2019-12-26 01:22 UTC

Requires

• guzzlehttp/guzzle: ~6.0
• jaxon-php/jaxon-dialogs: ^3.1
• jaxon-php/jaxon-view-blade: ~3.0
• vlucas/valitron: 1.4.*

GPL-v2

• Thierry Feuzeu

• ajax
• short url
• dashboard
• url shortener
• Jaxon
• Polr

README

An alternative admin dashboard for the Polr URL shortener.

The goal is to provide a dashboard for managing one or more Polr instances.

This dashboard is packaged as a Jaxon package, so it can be installed on any PHP web application.

The Polr API package needs to be installed on each instance of Polr to be managed.

Features

The features are mostly the same as Polr, but with few differences.

• The Polr instance to manage is chosen from a dropdown list.
• The dashboard can display stats for all links.
• The user related features are not included.
• AngularJS is dropped in favor of Jaxon https://www.jaxon-php.org.
• The package is a Jaxon package, and not a standalone application.
• All features are fully implemented with Ajax, using Jaxon.

Documentation

1. Install the jaxon library so it bootstraps from a config file and handles ajax requests. Here's the documentation.

2. Install this package with Composer. If a Jaxon plugin exists for your framework, you can also install it. It will automate the previous step.

3. Declare the package and the Polr servers in the app section of the Jaxon configuration file.

    'app' => [
        // Other config options
        // ...
        'packages' => [
            Lagdo\PolrAdmin\Package::class => [
                'servers' => [
                    'first' => [
                        'name'       => 'First server',
                        'url'        => 'https://first.server.addr',
                        'api'        => 'api/v2',
                        'key'        => 'first.server.key',
                    ],
                    'second' => [
                        'name'       => 'Second server',
                        'url'        => 'https://second.server.addr',
                        'api'        => 'api/v2',
                        'key'        => 'second.server.key',
                    ],
                ],
            ],
        ],
    ],

1. Insert the CSS and javascript codes in the HTML pages of your application using calls to jaxon()->getCss() and jaxon()->getScript(true).

2. In the page that displays the dashboard, insert its HTML code with a call to jaxon()->package(\Lagdo\PolrAdmin\Package::class)->getHtml(). Two cases are then possible.

   • If the dashboard is displayed on a dedicated page, make a call to jaxon()->package(\Lagdo\PolrAdmin\Package::class)->ready() when loading the page.

   • If the dashboard is loaded with an Ajax request in a page already displayed, execute the javascript code returned the call to jaxon()->package(\Lagdo\PolrAdmin\Package::class)->getReadyScript() when loading the page.

Notes

This package uses the Blade template engine to display its views. As a consequence, when using a PHP framework other than Laravel, the Blade package for Jaxon must also be installed.

{
    "require": {
        "jaxon-php/jaxon-blade": "^3.0",
    }
}

Contribute

• Issue Tracker: github.com/lagdo/polr-admin/issues
• Source Code: github.com/lagdo/polr-admin