README

Magic is a lightweight PHP/Laravel toolkit that auto-generates application files from entity configurations stored in JSON files.

It streamlines tasks like database migrations, seeding, and realistic data generation with Faker — making it ideal for testing, prototyping, and automation.

With Magic, you can build full-featured Laravel applications directly from configuration files, eliminating repetitive boilerplate and speeding up development.

🔧 How it works

🚀 Quick Start

Create a new Laravel project (if you don’t have one yet):
```
laravel new my-magic-app
```
When prompted:
- Choose Vue starter.
- Choose Laravel’s built-in authentication.
- Choose Pest for testing.
- Allow Laravel to install the required packages.
Navigate into your project:
```
cd my-magic-app
```
Install Magic via Composer:
```
composer require glugox/magic --dev
```

Publish the configuration file:

php artisan vendor:publish --provider="Glugox\Magic\MagicServiceProvider"

Explore demo samples (JSON config files in stubs/samples):
```
php artisan magic:list-samples
```

Build your app using a starter:

php artisan magic:build --starter=inventory

Or use your own config file:
```
php artisan magic:build --config=path/to/your/config.json
```
👉 See the sample configurations directory for examples.
Run the app:
```
npm run dev
php artisan serve
```

✨ Features

Entity Management – Define entities with fields, relations, casts.
CRUD Generation – Auto-generate CRUD for every entity.
Migrations – Create DB migrations from your definitions.
Seeding – Seed sample or Faker-based data.
Config-Driven – JSON-powered structure & behavior.
Extensible – Override stubs, extend generators.
Laravel Native – Fully integrated into Laravel workflow.
Development Mode – Quickly spin up test data.
Search & Sort – Mark fields as searchable/sortable.
Hidden Fields – Exclude fields from forms/views.
Casts – Ensure correct field data types.
Relations – Define hasMany, belongsTo, etc.

📦 Starter Kits

Use predefined configurations to bootstrap your app:

Task Management
E-commerce
Education
Resume Builder

How to use:

Pick a starter from the samples directory (use file name as starter name).
Run:
```
php artisan magic:build --starter=task
```

🤝 Contributing / Contact

Got ideas or feedback?
Reach out via email.

📄 License

The MIT License (MIT). See LICENSE for details.

composer require glugox/magic:@dev --prefer-source --repository='{"type":"path","url":"/Users/ervin/Code/github.com/glugox/magic"}'

glugox / magic

Maintainers

Details