DOCSEARCHbyAlgolia
Submit Docs

Krayin CRM Documentation

repository·2.2·Indexed 30 days ago

https://github.com/krayin/laravel-crm

An open-source CRM framework built on Laravel and Vue.js for SMEs and Enterprises. Features include modular architecture, custom attributes, lead management with AI-driven creation, activity scheduling, mail modules with IMAP support, and a customizable admin dashboard. Supports OpenRouter API for Magic AI integration and provides tools for data transfer, inventory management, and marketing automation.

Tokens
19.7K
Snippets
1
Records
132
Agent score
97%

What's inside krayin-laravel-crm

  2. Install Krayin CRM

    2.2

    To install Krayin CRM, create a new project using Composer and then run the built-in installation command.

    1. Create the project:
    composer create-project krayin/laravel-crm
    1. Configure your environment:
    • Open the .env file in the root directory.
    • Set APP_URL to your domain.
    • Configure your Mail and Database parameters.
    1. Run the installation command:
    php artisan krayin-crm:install

  3. Run Krayin CRM locally or on a server

    2.2

    Local Development

    To run the application on your local machine:

    php artisan route:clear
php artisan serve

    Production Server

    Before deploying to production, it is recommended to remove developer dependencies to optimize the installation:

    composer install --no-dev

    Default Admin Credentials

    Once installed, you can log in to the admin panel at http(s)://your-domain.com/admin/login using:

    • Email: admin@example.com
    • Password: admin123

  4. Migrate to Laravel 12 in Krayin CRM v2.2

    2.2

    Krayin CRM v2.2 has upgraded to Laravel 12. This version introduces stricter type checking and modernized date/time handling. If you have customized the core Laravel structure, you must adapt to the following architectural changes:

    Bootstrap and Configuration

    • Application Configuration: bootstrap/app.php now uses the Application::configure() builder pattern.
    • Service Providers: Service providers are now listed in bootstrap/providers.php instead of config/app.php.
    • Config Cleanup: The providers and aliases arrays have been removed from config/app.php.

    Removed Files and New Configuration Locations

    • Kernels: app/Http/Kernel.php and app/Console/Kernel.php are removed.
      • Configure Middleware in bootstrap/app.php.
      • Configure Scheduling in routes/console.php.
    • Exception Handler: app/Exceptions/Handler.php is removed. Configure exception handling in bootstrap/app.php.
    • Service Providers: AuthServiceProvider, EventServiceProvider, RouteServiceProvider, and BroadcastServiceProvider are removed. Move their logic to bootstrap/app.php or AppServiceProvider.

    Middleware and Dependencies

    • Middleware Wrappers: Built-in wrappers like EncryptCookies, VerifyCsrfToken, TrimStrings, and TrustProxies are removed. Customizations must now be performed via bootstrap/app.php.
    • Doctrine/DBAL: The doctrine/dbal dependency is no longer required as Laravel 12 supports native column modification.

  6. Configure VeeValidate global rules and validation settings

    2.2

    Krayin CRM uses vee-validate for form validation. The application pre-registers all standard validation rules from @vee-validate/rules and configures global behavior.

    Key configurations include:

    • Global Rules: All rules from @vee-validate/rules are registered via defineRule.
    • Validation Triggers: Validation is triggered on blur, input, and change events.
    • Custom Messages: Error messages are localized. A custom message for the phone field is provided as an example of how to extend the default English locale.
    • Global Components: The following components are registered globally for use in Vue templates:
      • VForm (from Form)
      • VField (from Field)
      • VErrorMessage (from ErrorMessage)

  7. Configure Magic AI with OpenRouter in Korean

    2.2

    The Magic AI settings in the Korean locale include the following configuration options:

    • Enable/Disable: enable (사용)
    • API Key Info: api-key-info (Notes that each model requires an OpenRouter API key for security and performance).
    • Model Selection: models (모델) includes presets like:
      • deepseek-r1: Deepseek R1 Distill-llama-8b
      • gemini-2-0-flash-001: Gemini 2.0 flash-001
      • gpt-4o: GPT-4.0
      • gpt-4o-mini: GPT-4.0 mini
      • grok-2-1212: Grok 2.12
      • llama-3-2-3b-instruct: Llama 3.2 3b Instruct
    • Custom Models: other-model (다른 모델을 사용하려면 OpenRouter의 모델 ID를 입력하세요.)
    • DOC Generation: doc-generation (DOC 생성) allows extracting data from DOC files into text format.

  9. Configure Admin Menu and Branding

    2.2

    The Admin dashboard menu and branding can be customized via settings:

    Menu Item Configurations

    You can manage the names of various menu items including activities, configuration, contacts, dashboard, draft, inbox, leads, mail, organizations, persons, products, quotes, sent, settings, trash, and outbox.

    Menu Color

    Change the color of the menu items via brand-color settings.

    Powered By Section

    Configure the text displayed in the 'Powered by' section of the footer.

  10. Configure Magic AI settings

    2.2
    Magic AI can be enhanced using an OpenRouter API key. You can enable the feature, select from supported models (such as deepseek-r1, gemini-2-0-flash-001, gpt-4o, gpt-4o-mini, grok-2-1212, or llama-3-2-3b-instruct), or specify an other-model using a Model ID from OpenRouter. Additionally, you can enable doc-generation to automatically extract data from DOC files and convert them into text format.

  11. Configure Admin Panel appearance and locale

    2.2

    You can customize the Admin panel's visual identity and language settings:

    Locale Settings

    Define the user interface language (e.g., ar for Arabic, en for English, es for Spanish, fa for Persian, or tr for Turkish).

    • Logo Image: Configure the primary logo image for the admin panel.
    • Favicon Image: Configure the favicon image for the admin panel.