This repository has been archived by the owner on Sep 5, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
688372e
commit 0c600ef
Showing
2 changed files
with
16 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,122 +1,49 @@ | ||
|
|
||
| ## Using this skeleton (remove this section after you have completed these steps) | ||
|
|
||
| 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:spatie/newly-created-repo.git`. Commit all files and push to master. | ||
|
|
||
| Next replace these variables in all files of your repo: | ||
| - `Alex Bowers` (example: 'Freek Van der Herten') | ||
| - `alexbowers` (example: 'freekmurze') | ||
| - `bowersbros@gmail.com` (example: 'freek@spatie.be') | ||
| - `nova-multiple-dashboard` (example: 'nova-tail-tool') | ||
| - `Support for multiple custom dashboards in Laravel Nova` (example: 'A tool to tail the log') | ||
| - `AlexBowers` (example: 'spatie') | ||
| - `AlexBowers` (example: 'Spatie') | ||
| - `MultipleDashboard` (example: 'TailTool') | ||
|
|
||
| Next run `composer install`, `yarn` and `yarn production`. | ||
|
|
||
| If you don't have a Nova app already head over the [nova installation instructions](https://nova.laravel.com/docs/1.0/installation.html#installing-nova). | ||
|
|
||
| To use your customized package in a Nova app, add this line in the `require` section of the `composer.json` file: | ||
|
|
||
| ``` | ||
| "AlexBowers/nova-multiple-dashboard": "*", | ||
| ``` | ||
|
|
||
| In the same `composer.json` file add a `repositiories` section with the path to your package repo: | ||
|
|
||
| ``` | ||
| "repositories": [ | ||
| { | ||
| "type": "path", | ||
| "url": "../nova-multiple-dashboard" | ||
| }, | ||
| ``` | ||
|
|
||
| Now you're ready to develop your package inside a Nova app. | ||
|
|
||
| **When you are done with the steps above delete everything above!** | ||
|
|
||
| # Support for multiple custom dashboards in Laravel Nova | ||
|
|
||
| [](https://packagist.org/packages/AlexBowers/nova-multiple-dashboard) | ||
|  | ||
| [](https://travis-ci.org/AlexBowers/nova-multiple-dashboard) | ||
| [](https://scrutinizer-ci.com/g/AlexBowers/nova-multiple-dashboard) | ||
| [](https://packagist.org/packages/AlexBowers/nova-multiple-dashboard) | ||
| [](https://packagist.org/packages/alexbowers/nova-multiple-dashboard) | ||
|  | ||
| [](https://scrutinizer-ci.com/g/alexbowers/nova-multiple-dashboard) | ||
| [](https://packagist.org/packages/alexbowers/nova-multiple-dashboard) | ||
|
|
||
|
|
||
| This is where your description should go. Try and limit it to a paragraph or two. | ||
| You can now add multiple custom dashboards in Laravel Nova. | ||
|
|
||
| Add a screenshot of the tool here. | ||
| Whether you want to group some cards together, have different dashboards visible depending on the logged in user, or want to provide a dashboard with your tool, Multiple Dashboards allows you to do this. | ||
|
|
||
|  | ||
|
|
||
| ## Installation | ||
|
|
||
| You can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer: | ||
|
|
||
| ```bash | ||
| composer require AlexBowers/nova-multiple-dashboard | ||
| ``` | ||
|
|
||
| Next up, you must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`. | ||
|
|
||
| ```php | ||
| // in app/Providers/NovaServiceProvider.php | ||
|
|
||
| // ... | ||
|
|
||
| public function tools() | ||
| { | ||
| return [ | ||
| // ... | ||
| new \AlexBowers\MultipleDashboard\Tool(), | ||
| ]; | ||
| } | ||
| composer require alexbowers/nova-multiple-dashboard | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Click on the "nova-multiple-dashboard" menu item in your Nova app to see the tool provided by this package. | ||
| There is now a `php artisan nova:dashboard <name>` command exposed via the CLI. | ||
|
|
||
| ### Testing | ||
| If you run this, you'll get a `App/Nova/Dashboards` directory created, which will house your custom dashboards. | ||
|
|
||
| ``` bash | ||
| composer test | ||
| ``` | ||
| If you are another package creating a nova dashboard, you will need to register it using: | ||
|
|
||
| ### Changelog | ||
|
|
||
| Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. | ||
| ```php | ||
| \AlexBowers\MultipleDashboard\DashboardNova::registerDashboards(new \Your\Dashboard\Here); | ||
| ``` | ||
|
|
||
| ## Contributing | ||
| You can register multiple at once by passing through to the `DashboardNova::registerDashboards` function. | ||
|
|
||
| Please see [CONTRIBUTING](CONTRIBUTING.md) for details. | ||
|
|
||
| ### Security | ||
|
|
||
| If you discover any security related issues, please email bowersbros@gmail.com instead of using the issue tracker. | ||
|
|
||
| ## Postcardware | ||
|
|
||
| You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. | ||
|
|
||
| Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium. | ||
|
|
||
| We publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards). | ||
|
|
||
| ## Credits | ||
|
|
||
| - [Alex Bowers](https://github.com/alexbowers) | ||
|
|
||
| ## Support us | ||
|
|
||
| Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource). | ||
|
|
||
| Does your business depend on our contributions? Reach out and support us on [Patreon](https://www.patreon.com/spatie). | ||
| All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff. | ||
|
|
||
| ## License | ||
|
|
||
| The MIT License (MIT). Please see [License File](LICENSE.md) for more information. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.