polar-white / laravel-gpt-architect
A Laravel package to generate GPT-friendly project blueprints
Requires
- php: ^7.3|^8.0
- doctrine/dbal: ^3.7
- illuminate/support: ^7.0|^8.0|^9.0|^10.0|^11.0
README
LaravelGptArchitect is a Laravel package designed to generate GPT-friendly project blueprints. It creates a comprehensive overview of your Laravel application's database schema, models, services, and dependencies, in a format that can be easily consumed by custom GPT models.
Features
- Generates a detailed description of database tables.
- Includes information about models, relationships, and methods.
- Captures services with their properties and methods.
- Extracts dependencies from
composer.json
andpackage.json
.
Installation
To install the package, run the following command in your Laravel project:
composer require polar-white/laravel-gpt-architect
Configuration
Publish the configuration file to customize the output:
php artisan vendor:publish --provider="PolarWhite\LaravelGptArchitect\LaravelGptArchitectServiceProvider"
You can then edit the published config/gpt-architect.php
file according to your needs.
Usage
To generate the GPT resource file, run:
php artisan make:gpt-plan
The default output will be located at <project root>/gpt-plan.txt
.
Contributing
Contributions are welcome! Please read our Contributing Guide for details.
License
This package is open-sourced software licensed under the MIT license.