PHPackages                             proxima/orm - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. proxima/orm

ActiveLibrary[Database & ORM](/categories/database)

proxima/orm
===========

Django-inspired Active Record ORM for PHP 8+ with automatic schema synchronization and professional admin panel

32PHP

Since Jan 14Pushed 4mo agoCompare

[ Source](https://github.com/proxyhk/proxima-orm)[ Packagist](https://packagist.org/packages/proxima/orm)[ RSS](/packages/proxima-orm/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

NON FINISHED PLEASE DONT USE.
=============================

[](#non-finished-please-dont-use)

 [![PHP 8.0+](https://camo.githubusercontent.com/7d5a9af49a15e8bc2fb38caa3edfcac9d98a4d3cdf53d6cef1f0b4e03570d45b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e302b2d3838393242463f7374796c653d666f722d7468652d6261646765266c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/7d5a9af49a15e8bc2fb38caa3edfcac9d98a4d3cdf53d6cef1f0b4e03570d45b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e302b2d3838393242463f7374796c653d666f722d7468652d6261646765266c6f676f3d706870266c6f676f436f6c6f723d7768697465) [![License](https://camo.githubusercontent.com/1736263e7abccd5448e130c257555354792cbceae6b18535e86d6157f95b906f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75653f7374796c653d666f722d7468652d6261646765)](https://camo.githubusercontent.com/1736263e7abccd5448e130c257555354792cbceae6b18535e86d6157f95b906f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75653f7374796c653d666f722d7468652d6261646765) [![Active Record](https://camo.githubusercontent.com/966690eb2a5099700074a88e5af539c43b5489784f2564f06784fd82b29294ff/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f524d2d4163746976655f5265636f72642d3633363666313f7374796c653d666f722d7468652d6261646765)](https://camo.githubusercontent.com/966690eb2a5099700074a88e5af539c43b5489784f2564f06784fd82b29294ff/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f524d2d4163746976655f5265636f72642d3633363666313f7374796c653d666f722d7468652d6261646765) [![Type Safe](https://camo.githubusercontent.com/48506c98f340749ff511ea269cfb9d67444a85021c390527701ac5525e3213be/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f547970652d536166652d3130623938313f7374796c653d666f722d7468652d6261646765)](https://camo.githubusercontent.com/48506c98f340749ff511ea269cfb9d67444a85021c390527701ac5525e3213be/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f547970652d536166652d3130623938313f7374796c653d666f722d7468652d6261646765)

⚡ Proxima ORM
=============

[](#-proxima-orm)

 **Modern, Django-inspired Active Record ORM for PHP 8+**
 Automatic schema synchronization • Professional admin panel • Zero configuration migrations

 [Features](#-features) • [Installation](#-installation) • [Quick Start](#-quick-start) • [Documentation](#-documentation) • [CLI](#-cli-commands)

---

✨ Features
----------

[](#-features)

### 🎯 Core Features

[](#-core-features)

- **PHP 8 Attributes** - Define models with modern syntax
- **Active Record Pattern** - Intuitive, object-oriented database operations
- **Auto Schema Sync** - Automatic table creation and synchronization
- **Type Safety** - Full PHP type hints support
- **Zero Configuration** - Convention over configuration

### 🛠️ Advanced Features

[](#️-advanced-features)

- **Professional Admin Panel** - Django-like admin interface
- **CLI Migration Tool** - Powerful command-line migrations
- **Query Builder** - Fluent, chainable query interface
- **Exception Handling** - Django-style error management
- **Model Discovery** - Auto-detection of model classes

---

📦 Installation
--------------

[](#-installation)

### Step 1: Install via Composer

[](#step-1-install-via-composer)

```
composer require proxima/orm
```

### Step 2: Run the Setup Wizard 🖥️

[](#step-2-run-the-setup-wizard-️)

After installation, **run the Admin Panel setup wizard** to configure your project:

```
http://yoursite.com/vendor/proxima/orm/admin/setup.php

```

The setup wizard will:

- ✅ Create `proxima.settings.php` - Your configuration file
- ✅ Create `models/` directory - For your model classes
- ✅ Create `admin/` directory - Admin panel interface
- ✅ Configure database connection
- ✅ Set up admin credentials

### Step 3: Follow the 3-Step Wizard

[](#step-3-follow-the-3-step-wizard)

1. **Select Project Directory** - Choose where your project lives
2. **Configure Database** - Enter your MySQL connection details
3. **Create Admin Account** - Set username and password

After setup, you'll receive your **Admin Panel URL**:

```
http://yoursite.com/yourproject/admin/index.php?token=YOUR_TOKEN

```

> ⚠️ **Important:** Save this URL securely! The token cannot be recovered if lost.

### Requirements

[](#requirements)

- PHP 8.0 or higher
- PDO extension
- MySQL database

---

🚀 Quick Start
-------------

[](#-quick-start)

### 1️⃣ Create Your Model

[](#1️⃣-create-your-model)

Create `models/User.php` in your project:

```