Skip to content

Commit b9e044e

Browse files
add documentation for community maintained starter kits (#10236)
* add documentation for community maintained starter kits * add anchor tag * update section title * Update starter-kits.md * Update starter-kits.md --------- Co-authored-by: Taylor Otwell <[email protected]>
1 parent 4dbcf97 commit b9e044e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

starter-kits.md

+15
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
- [Livewire](#livewire-customization)
1313
- [WorkOS AuthKit Authentication](#workos)
1414
- [Inertia SSR](#inertia-ssr)
15+
- [Community Maintained Starter Kits](#community-maintained-starter-kits)
1516
- [Frequently Asked Questions](#faqs)
1617

1718
<a name="introduction"></a>
@@ -321,6 +322,20 @@ For convenience, a `composer dev:ssr` command is also available. This command wi
321322
composer dev:ssr
322323
```
323324

325+
<a name="community-maintained-starter-kits"></a>
326+
### Community Maintained Starter Kits
327+
328+
When creating a new Laravel application using the Laravel installer, you may provide any community maintained starter kit available on Packagist to the `--using` flag:
329+
330+
```shell
331+
laravel new my-app --using=example/starter-kit
332+
```
333+
334+
<a name="creating-starter-kits"></a>
335+
#### Creating Starter Kits
336+
337+
To ensure your starter kit is available to others, you will need to publish it to [Packagist](https://packagist.org). Your starter kit should define its required environment variables in its `.env.example` file, and any necessary post-installation commands should be listed in the `post-create-project-cmd` array of the starter kit's `composer.json` file.
338+
324339
<a name="faqs"></a>
325340
### Frequently Asked Questions
326341

0 commit comments

Comments
 (0)