README

This repo contains a skelton to easily create Nova Tool packages. It contains a few niceties not present in the default Nova Tool scaffolding.

First clone this repo to your development machine and remove the .git directory. Next run git init to create another repo. Create a new repo on GitHub (or another source control saas) and point the origin remote of your cloned repo to the one you just created. Here's an example: git remote add origin git@github.com:CodeStacked/nova-tool.git. Commit all files and push to master.

Next run composer install, yarn and yarn production.

If you don't have a Nova app already head over the nova installation instructions.

To use your customized package in a Nova app, add this line in the require section of the composer.json file:

   "codebase/nova-tool": "*",

In the same composer.json file add a repositiories section with the path to your package repo:

    "repositories": [
        {
            "type": "path",
            "url": "../nova-tool"
        },

Now you're ready to develop your package inside a Nova app.

When you are done with the steps above delete everything above!

Laravel Nova Tool

This is where your description should go. Try and limit it to a paragraph or two.

Add a screenshot of the tool here.

Installation

You can install the package in to a Laravel app that uses Nova via composer:

composer require codebase/nova-tool

Next up, you must register the tool with Nova. This is typically done in the tools method of the NovaServiceProvider.

// in app/Providers/NovaServiceProvider.php

// ...

public function tools()
{
    return [
        // ...
        new \Stack\Nova\Tools\Tool(),
    ];
}

Usage

Click on the "nova-tool" menu item in your Nova app to see the tool provided by this package.

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email io.codestack@gmail.com instead of using the issue tracker.

Credits

Carlo Rademan

License

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

codebase / nova-tool

Maintainers

Details