README

This is a package that is meant to help provide in-sutro explanations to devs

Installation

Via Composer

composer require eleganttechnologies/grok #while in development, add repo and master-dev insert manually into composer and cdo composer update

php artisan vendor:publish --provider="ElegantTechnologies\Grok\GrokServiceProvider"

[ ] Add the following line to your routes/web.php file...... oh, there must be a more laravel-ish way

{{-- in 'routes/web.php' --}}
require_once(base_path('vendor/eleganttechnologies/grok/routes/web.php'));

[ ] Add a link in the grok pages (wherever is appropriate for your site). In a fresh install of jetstream, you would problably add it next to the 'Dashboard' link at the top.

{{-- in 'resources/views/navigation-dropdown.blade.php' --}}

<x-jet-nav-link href="/grok" :active="request()->routeIs('grok*')">
    Grok
</x-jet-nav-link>

Load the css and js.
[ ] Add this to 'resources/views/layouts/app.blade.php'

<!-- In <head> -->
<head>
    ...
    <!-- Code highlighting 1 of 2-->
    <link href="/css/prism.css" rel="stylesheet" />
</head>

<body>
    ...
    <!-- Code highlighting 2 of 2 -->
    <script src="/js/prism.js"></script>
</body>

You can grok the routes (when .env(local)) by visiting

http://test-eleganttechnologies.test/grok/ElegantTechnologies/Grok/string

http://test-eleganttechnologies.test/grok/ElegantTechnologies/Grok/controller

This is the contents of the published config file:

return [
];

Usage

$grok = new ElegantTechnologies\Grok();
echo $grok->echoPhrase('Hello, ElegantTechnologies!');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

eleganttechnologies / grok

Maintainers

Details