{"id":13791538,"url":"https://github.com/spatie/skeleton-nova-tool","last_synced_at":"2025-05-07T20:34:59.744Z","repository":{"id":34321779,"uuid":"144541589","full_name":"spatie/skeleton-nova-tool","owner":"spatie","description":"A skeleton repository for Spatie's Nova Packages","archived":false,"fork":false,"pushed_at":"2023-05-05T07:42:10.000Z","size":77,"stargazers_count":202,"open_issues_count":0,"forks_count":22,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-08-04T22:15:52.955Z","etag":null,"topics":["laravel","nova","package","php","skeleton"],"latest_commit_sha":null,"homepage":"https://murze.be/introducing-our-laravel-nova-packages","language":"PHP","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/spatie.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"spatie"}},"created_at":"2018-08-13T07:01:52.000Z","updated_at":"2024-03-22T14:22:58.000Z","dependencies_parsed_at":"2022-08-09T08:36:47.706Z","dependency_job_id":null,"html_url":"https://github.com/spatie/skeleton-nova-tool","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fskeleton-nova-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fskeleton-nova-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fskeleton-nova-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fskeleton-nova-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spatie","download_url":"https://codeload.github.com/spatie/skeleton-nova-tool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223903484,"owners_count":17222551,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["laravel","nova","package","php","skeleton"],"created_at":"2024-08-03T22:01:01.530Z","updated_at":"2024-11-10T02:08:11.140Z","avatar_url":"https://github.com/spatie.png","language":"PHP","funding_links":["https://github.com/sponsors/spatie"],"categories":["PHP","Others","Packages"],"sub_categories":["Tools"],"readme":"\n[\u003cimg src=\"https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1\" /\u003e](https://supportukrainenow.org)\n\n\n\n## Support us\n\n[\u003cimg src=\"https://github-ads.s3.eu-central-1.amazonaws.com/skeleton-nova-tool.jpg?t=1\" width=\"419px\" /\u003e](https://spatie.be/github-ad-click/skeleton-nova-tool)\n\nWe invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).\n\nWe highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).\n\n\u003c!--delete--\u003e\n\n## Using this skeleton (remove this section after you have completed these steps)\n\n---\nThis repo can be used to scaffold a Laravel package. Follow these steps to get started:\n\n1. Press the \"Use this template\" button at the top of this repo to create a new repo with the contents of this skeleton.\n2. Run \"php ./configure.php\" to run a script that will replace all placeholders throughout all the files.\n3. Have fun creating your package.\n4. If you need help creating a package, consider picking up our \u003ca href=\"https://laravelpackage.training\"\u003eLaravel Package Training\u003c/a\u003e video course.\n---\n\n## Manual Setup\nThis repo contains a skeleton to easily create Nova Tool packages. It contains a few niceties not present in the default Nova Tool scaffolding.\n\nFirst 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.\n\nNext replace these variables in all files of your repo:\n - `:author_name` (example: 'Freek Van der Herten')\n - `:author_username` (example: 'freekmurze')\n - `:author_email` (example: 'freek@spatie.be')\n - `:package_name` (example: 'nova-tail-tool')\n - `:package_description` (example: 'A tool to tail the log')\n - `:vendor` (example: 'spatie')\n - `:namespace_vendor` (example: 'Spatie')\n - `:namespace_tool_name` (example: 'TailTool')\n \n Next run `composer install`, `yarn` and `yarn production`.\n \nIf 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).\n\nTo use your customized package in a Nova app, add this line in the `require` section of the `composer.json` file:\n \n ```\n    \":vendor/:package_name\": \"*\",\n```\n \n In the same `composer.json` file add a `repositiories` section with the path to your package repo:\n \n ```\n     \"repositories\": [\n         {\n             \"type\": \"path\",\n             \"url\": \"../:package_name\"\n         },\n```\n \nNow you're ready to develop your package inside a Nova app.\n \n**When you are done with the steps above delete everything above!**\n\u003c!--/delete--\u003e\n# :package_description\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor/:package_name.svg?style=flat-square)](https://packagist.org/packages/:vendor/:package_name)\n![CircleCI branch](https://img.shields.io/circleci/project/github/:vendor/:package_name/master.svg?style=flat-square)\n[![Build Status](https://img.shields.io/travis/:vendor/:package_name/master.svg?style=flat-square)](https://travis-ci.org/:vendor/:package_name)\n[![Quality Score](https://img.shields.io/scrutinizer/g/:vendor/:package_name.svg?style=flat-square)](https://scrutinizer-ci.com/g/:vendor/:package_name)\n[![Total Downloads](https://img.shields.io/packagist/dt/:vendor/:package_name.svg?style=flat-square)](https://packagist.org/packages/:vendor/:package_name)\n\n\nThis is where your description should go. Try and limit it to a paragraph or two.\n\nAdd a screenshot of the tool here.\n\n## Installation\n\nYou can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:\n\n```bash\ncomposer require :vendor/:package_name\n```\n\nNext up, you must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`.\n\n```php\n// in app/Providers/NovaServiceProvider.php\n\n// ...\n\npublic function tools()\n{\n    return [\n        // ...\n        new \\:namespace_vendor\\:namespace_tool_name\\Tool(),\n    ];\n}\n```\n\n## Usage\n\nClick on the \":package_name\" menu item in your Nova app to see the tool provided by this package.\n\n## Testing\n\n``` bash\ncomposer test\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.\n\n## Security\n\nIf you discover any security related issues, please email :author_email instead of using the issue tracker.\n\n## Postcardware\n\nYou'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.\n\nOur address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.\n\nWe publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards).\n\n## Credits\n\n- [:author_name](https://github.com/:author_username)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspatie%2Fskeleton-nova-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspatie%2Fskeleton-nova-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspatie%2Fskeleton-nova-tool/lists"}