Skip to content

Commit c15118f

Browse files
Add support for reusable project templates in LaravelFS
Introduce a new feature allowing users to save and reuse project setups with Templates. Provides commands for creating, viewing, and using templates, streamlining Laravel project initialization. Additionally, updates the README with detailed instructions on this functionality.
1 parent f6d1a75 commit c15118f

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
**LaravelFS** was born from the idea of "Laravel Full Starter Kits" (or Full Stack) LOL – a way to bring back the legacy starter kits like Breeze and Jetstream that were removed from the official Laravel Installer, while still supporting the new Laravel 12 starter kits and custom solutions via Composer.
44

5-
65
> 🚨 **Disclaimer:** This installer is **not officially supported by the Laravel team**. It's a **community-driven alternative** that extends the Laravel Installer by supporting **abandoned starter kits** like Breeze and Jetstream, as well as allowing **custom starter kits** via Composer.
76
We strive to keep it **up-to-date with Laravel's official installer** while offering extended flexibility. 🚀
87

@@ -15,6 +14,7 @@ LaravelFS functions similarly to the Laravel Installer but with **extra capabili
1514
✅ Install Laravel projects just like the official installer.
1615
✅ Support for **Breeze and Jetstream**, even if they are abandoned.
1716
✅ Install **custom starter kits** from Packagist.
17+
✅ Save and reuse project setups with **Templates**.
1818
✅ Ensure that provided starter kits are **Composer packages of type `project`**.
1919
✅ CLI command to fetch additional details about a starter kit package.
2020

@@ -52,6 +52,47 @@ Even if these starter kits are abandoned, LaravelFS ensures they remain **availa
5252

5353
---
5454

55+
## **🚀 New Feature: Templates!**
56+
Tired of typing the same options for every new Laravel project? With **LaravelFS Templates**, you can save your preferred project setup and reuse it anytime!
57+
58+
### **Creating a Template**
59+
To create a reusable template, use:
60+
61+
```sh
62+
laravelfs new:template my-template
63+
```
64+
65+
This will prompt you the same way as `laravelfs new`, but instead of creating a project, it **saves your setup** as a template.
66+
67+
> 📝 **Templates include:**
68+
> - Selected starter kits (Breeze, Jetstream, Vue, React, Livewire)
69+
> - Custom starter-kit options
70+
> - Extra flags like `--typescript`, `--ssr`, `--api`, etc.
71+
72+
### **Viewing Saved Templates**
73+
List all saved templates:
74+
75+
```sh
76+
laravelfs template:show
77+
```
78+
79+
Or view a specific template:
80+
81+
```sh
82+
laravelfs template:show my-template
83+
```
84+
85+
### **Using a Template**
86+
Once saved, you can use your template anytime:
87+
88+
```sh
89+
laravelfs use my-template my-project
90+
```
91+
92+
This runs the exact same command as if you typed everything manually!
93+
94+
---
95+
5596
## **Installing Custom Starter Kits**
5697
LaravelFS allows you to install **custom Laravel starter kits** from Packagist by providing the package name:
5798

0 commit comments

Comments
 (0)