Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/happytodev/larafil
A Laravel Zero based CLI to install Laravel and Filament easily
https://github.com/happytodev/larafil
Last synced: 3 months ago
JSON representation
A Laravel Zero based CLI to install Laravel and Filament easily
- Host: GitHub
- URL: https://github.com/happytodev/larafil
- Owner: happytodev
- Created: 2024-04-29T15:30:32.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-08T22:07:46.000Z (9 months ago)
- Last Synced: 2024-06-09T10:09:02.174Z (8 months ago)
- Language: PHP
- Size: 26.8 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Larafil was created by [HappyToDev](https://github.com/happytodev) and was inspired by a [Povilas Korop](https://github.com/LaravelDaily)'s [tweet](https://x.com/povilaskorop/status/1784916290982826462?s=46&t=8FgNEQBLlkAK3L6Zwe_KyQ).
In one line, you can install Laravel and FilamenPHP :
Exemple :
`larafil install myNewAwesomeProject --create-user --filament-url=batcave --mysql --serve`
With this single line, **Larafil**
- will install Laravel (last version) in a directory called `myNewAwesomeProject`
- change default SQLite database by a MySQL database in your `.env` file, create the MySQL database, launch migrations, remove `database.sqlite` database
- will install FilamentPHP
- ask you to create the first Filament user
- ask you if you want to install some Filament Plugins (For now, only these plugins are supported as a proof of concept : 'None (default)', 'Breezy', 'Curator', 'Shield', 'Spatie Role Permissions')
- change the FilamentPHP admin URL to `batcave`
- start the integrated server
Every option is optional.
If you don't provide the name of the application, Larafil will ask you for it, so you can perfectly use this command instead of that above :
`larafil install --create-user --filament-url=batcave --mysql --serve`
when Larafil will ask you for the name of the project, it wiil be up to you to give you the name.
## How to use Larafil
Get it on Packagist
```bash
composer global require happytodev/larafil
```
and just use it :
```bash
larafil install
```
It will ask you the name of your future application.
### Customize FilamentPHP admin url
You can change the default '/admin' url to the url you want. You have just to pass the option with your new value :
```bash
larafil install --filament-url=batcave
```
Once the installation finished, you can access to your dashboard with `/batcave>`
### Create a Filament user
You can ask for a Filament user creation at the end of the installation :
```bash
larafil install --create-user
```
### Serve your application
You can also ask to launch Laravel integrated server after the installation :
```bash
larafil install --serve
```
Of course, you can combine the two options together :
```bash
larafil install --create-user --serve
```
### Use MySQL database instead SQLite default one
If you want to use MySQL database instead the sqlite default one, you can use the `--mysql` option :
```bash
larafil install --create-user --mysql --serve
```
### Use Laravel 10 instead of Laravel 11
If you want to use Laravel 10 instead Laravel 11, you can pass the `l10` option during installation :
```bash
larafil install --create-user --laravel-version=previous --serve
```
Nota : you can't use `l10` and `mysql` option together. That's because Laravel 10 use mysql by default. For Laravel 11, it's SQLite by default.
If you try to use both together, you will have an error and the install stops.
The purpose of Larafil was to play with Laravel Zero from [Nuno Maduro](https://github.com/nunomaduro).
## How to build Larafil
1. git clone
```bash
git clone https://github.com/happytodev/larafil.git larafil
```
2. Composer install
```bash
composer install
```
3. Build the app
```bash
php larafil app:build
```
4. It's ready
```bash
./builds/larafil -V
```
## Support the development
I don't know if there is another thing to develop for Larafil but tell me. It will be my pleasure to develop some good ideas for this little project.
**Do you like this project? Support it by donating**
- PayPal: [Donate](https://www.paypal.com/donate/?hosted_button_id=VSVEWSM2U437Q)
- Ko-Fi: [Donate](https://ko-fi.com/happytodev/)
## Interested by Laravel 11 ?
[Get my free ebook about news in Laravel 11](https://ko-fi.com/s/7a573b69b0)
## License
Larafil is an open-source software licensed under the MIT license.