README

⚡ The Declarative PHP Framework for Modern Development

Build secure, enterprise-grade applications in record time using Configuration over Programming and AI Vibecoding.

Stop writing repetitive code. Ragnos automatically generates APIs, UIs, and complex validations from your data models.

📚 Official Manual Available Now!

Learn Ragnos from zero to pro with our comprehensive guides:

💡 What is Ragnos?

Ragnos is a modern, lightweight PHP framework that revolutionizes web application development through declarative programming. Built on the solid foundation of CodeIgniter 4, it integrates Vanilla JavaScript, DataTables 3, and AdminLTE 4 to deliver a complete, efficient development experience.

Core Philosophy

Instead of writing boilerplate code, you define your data structure and business rules once—Ragnos handles the rest. Controllers, views, APIs, validations, and UI components are generated automatically.

✨ Key Features

Feature	Benefit
💾 Declarative Datasets	Define data structure once, get a fully functional CRUD module with APIs automatically
🔌 Hybrid Core (HTML + API)	Your admin panel automatically serves as a secure RESTful API for mobile and modern frontends
🛡️ Enterprise Security	RBAC, immutable audit logs, and automatic OWASP Top 10 mitigation out of the box
⚡ Zero Configuration	Works instantly with smart defaults; customize only what you need
📊 Advanced Data Tables	Built-in search, filtering, pagination, and sorting with DataTables integration
🎨 Beautiful UI	AdminLTE 4 provides a modern, fully responsive interface ready for production
🚀 Native REST API	Expose your data to mobile apps and SPAs with integrated token-based security
📱 Responsive Design	Mobile-first approach ensuring perfect display on all devices

🏗️ Built on Proven Technology

Ragnos leverages industry-standard technologies:

CodeIgniter 4 — Ultra-lightweight PHP framework with minimal learning curve
AdminLTE 4 — Modern dashboard UI built on Bootstrap 5, fully customizable and responsive
Vanilla JavaScript & DataTables 3 — Robust client-side data manipulation without jQuery or build complexity
Bootstrap — Responsive design framework for consistent, professional appearance
MariaDB/MySQL — Powerful relational database support with advanced querying

🚀 Quick Start

Installation

Choose the method that best fits your workflow:

Via Composer (Recommended for new projects — ultra-lightweight):
```
composer create-project --no-dev cgarciagl/ragnos mi-proyecto
cd mi-proyecto
```
(Omit --no-dev if you plan to write and run unit tests with PHPUnit).
Quick Standalone ZIP (No Composer or Git needed):
Download the ready-to-use ragnos.zip (includes CodeIgniter 4 and all dependencies pre-installed in vendor/) and extract it into your web server directory.

Configuration & Database

Configure the environment:
- Copy .env.example to .env (automatically copied and encryption key generated if installed via composer create-project; never commit .env)
- Update database credentials and base URL
Create the database (named as in your .env, ragnos by default) and import the system tables:
```
mysql -u root -p ragnos < sampledatabase/ragnos_base.sql
```
💡 Prefer a GUI? Try PyroStudio, the native MariaDB/MySQL client by the author of Ragnos: right-click the database → Backup / Restore → Restore into Existing DB.
(Optional) Load the demo — a scale-model store with catalogs, reports and a sales dashboard:
```
mysql -u root -p ragnos < sampledatabase/demo_classicmodels.sql
```
Access your application at the configured URL (e.g., http://localhost/mi-proyecto/public) and sign in with admin / admin

For detailed installation instructions, see the Official Documentation or the book Ragnos from Zero to Pro

Create Your First Dataset

Create the database table (SQL):

CREATE TABLE `tasks` (
  `id_task` int(11) NOT NULL AUTO_INCREMENT,
  `title` varchar(100) NOT NULL,
  `description` text,
  `status` enum('pending','in_progress','completed') DEFAULT 'pending',
  PRIMARY KEY (`id_task`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Generate the controller in your terminal:

php spark ragnos:make Modules/Tasks -table tasks

Configure your dataset in app/Controllers/Modules/Tasks.php:

namespace App\Controllers\Modules;

use Ragnos\Controllers\RDatasetController;

class Tasks extends RDatasetController
{
    public function __construct()
    {
        parent::__construct();
        $this->checkLogin();
        $this->setTitle('Tasks Management');
        $this->setTableName('tasks');
        $this->setIdField('id_task');

        $this->addField('title', [
            'label' => 'Task Title',
            'rules' => 'required|min_length[3]'
        ]);

        $this->addField('description', [
            'label' => 'Details',
            'type'  => 'textarea'
        ]);

        $this->addField('status', [
            'label' => 'Status',
            'type'  => 'select',
            'options' => [
                'pending' => 'Pending',
                'in_progress' => 'In Progress',
                'completed' => 'Completed'
            ]
        ]);

        $this->setTableFields(['title', 'status']);
    }
}

Access in your browser at http://localhost/mi-proyecto/public/modules/tasks

That's it! Ragnos automatically generates:

✅ Complete CRUD interface
✅ RESTful API endpoints
✅ Form validations
✅ Data security
✅ Search and filtering
✅ Automated reports and exports

📖 Documentation & Resources

📚 Official Manual — Comprehensive guide to mastering Ragnos
🌐 Live Demo — See Ragnos in action
💬 Discord Community — Connect with developers and get support
🔗 GitHub Repository — Source code and issue tracking

⚙️ Requirements

PHP 8.1 or higher, with the intl, mbstring, and mysqli extensions
Composer 2.x
MariaDB 10.2.1+ or MySQL 8.0+ (RQueryController relies on common table expressions, WITH)

🛠️ Available Commands

# List all available Ragnos commands
php spark list

# Generate a new Dataset Controller from database table
php spark ragnos:make Modules/Users -table users

# Generate a Query Controller from SQL query
php spark ragnos:make:query Dashboard/Reports -query "SELECT * FROM users"

# Start development server
php spark serve

🎯 Use Cases

✅ Admin Panels — Build feature-rich dashboards in hours, not weeks
✅ REST APIs — Generate production-ready APIs automatically
✅ Mobile Backends — Serve iOS/Android apps with built-in security
✅ MVPs & Prototypes — Rapid application development for startups
✅ Enterprise Apps — Scalable, secure, and maintainable applications

🤝 Contributing

We welcome contributions! Please feel free to submit pull requests or open issues for bugs and feature requests.

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

📄 License

This project is licensed under the MIT License — see LICENSE file for details.

💡 Philosophy: Configuration Over Programming

Ragnos embodies the principle that configuration should be preferred over writing repetitive code. By declaratively describing what you need, the framework handles the implementation details, allowing developers to focus on business logic and user experience.

🌟 Recognition & Community

⭐ Star us on GitHub
💬 Join our Discord community
📢 Follow us on social media for updates and announcements

Built with ❤️ for developers who value their time

GitHub • Discord • Get the Book

cgarciagl / ragnos

Package info

Security

Statistics