Getting Started
Installation

Installation

Welcome to the installation guide for the Laravel CycleORM Adapter. This document will walk you through the setup process to get you up and running quickly.

🚩 Prerequisites

Before you begin, ensure your development environment meets the following requirements:

  • PHP Version: 8.2 or higher
  • Laravel: 10.x, 11.x, or 12.x

🧩 Compatibility Map

LaravelCycle ORMAdapter
^10.282.x<4.9.0
^10.28, 11.x2.x≥4.9.0
^10.28, 11.x, 12.x2.x≥5.0.0

🚀 Quick Start

Installing the Laravel CycleORM Adapter is straightforward with Composer. Follow the steps below to add the adapter to your Laravel project.

Step: Install the Adapter

For the core functionality, run the following Composer command in your terminal:

$ composer req wayofdev/laravel-cycle-orm-adapter

This command installs the wayofdev/laravel-cycle-orm-adapter package, integrating CycleORM into your Laravel application.

Step: Publish Configuration

After installing the package, publish the configuration file using the vendor:publish command:

$ php artisan vendor:publish \
  --provider="WayOfDev\Cycle\Bridge\Laravel\Providers\CycleServiceProvider"

🏭 Database Factories (Optional)

If you need support for Eloquent-like Factories, install the following package:

$ composer req --dev wayofdev/laravel-cycle-orm-factories

which will install the wayofdev/laravel-cycle-orm-factories package to provide similar functionality

Getting StartedConfiguration