atifsoftware / novaflow

v1.0.3 2026-07-23 03:31 UTC

Requires

• php: >=8.1

Requires (Dev)

• phpunit/phpunit: ^11.5

MIT

• Mohidul Hasan

• framework
• php
• mvc
• admin-panel
• novaFlow

Published on Packagist.org on 2026-07-23 06:32 UTC

README

NovaFlow PHP Framework

🚀 A lightweight, high-performance PHP MVC framework with premium admin panel

✨ Features

• MVC Architecture - Clean separation of concerns
• Dependency Injection - Built-in IoC Container
• RESTful API - Built-in API controller with JWT support
• Authentication - Session & JWT based auth
• Rate Limiting - Built-in brute force protection
• Query Builder - Secure database operations with PDO
• Active Record Models - Eloquent-like model support
• Middleware System - Flexible request filtering
• CLI Tools - Code generation & database migrations
• Bilingual Docs - English & Bengali documentation

📋 Requirements

• PHP 8.1 or higher
• MySQL 5.7+ / MariaDB 10.2+
• Apache/Nginx with mod_rewrite

🛠️ Installation

Via Composer (Recommended)

composer create-project atifsoftware/novaflow myproject
cd myproject

Manual Installation

# Clone the repository
git clone https://github.com/yourusername/NovaFlow.git myproject
cd myproject

# Install dependencies
composer install

# Configure environment
cp .env.example .env

# Import database
mysql -u root -p novaflow_db < novaflow_db.sql

⚙️ Configuration

Database Setup (.env)

DB_HOST=localhost
DB_NAME=novaflow_db
DB_USER=root
DB_PASS=
DB_DRIVER=pdo

JWT_SECRET=your-secret-key-here
APP_ENV=local

Routes (config/routes.php)

// Simple route
$router->get('/', 'HomeController@index');

// Protected routes
$router->group(['prefix' => 'admin', 'middleware' => 'auth'], function($router) {
    $router->get('/dashboard', 'AdminDashboardController@index');
});

// API routes
$router->group(['prefix' => 'api/v1'], function($router) {
    $router->post('/login', 'AuthApiController@login');
});

📖 Documentation

• English Documentation
• বাংলা ডকুমেন্টেশন

Quick Examples

Create a Controller

namespace App\Controllers;

use NovaFlow\Core\Controller;

class ProductController extends Controller {
    public function index() {
        $products = ProductModel::all();
        $this->view('products.index', ['products' => $products]);
    }
}

Database Query

use NovaFlow\Core\DB;

// Get all active products
$products = DB::table('products')->where('status', 'active')->get();

// Get single record
$user = DB::table('users')->where('email', $email)->first();

Authentication

use App\Services\AuthService;

$auth = Container::make(AuthService::class);
$result = $auth->login('email', 'password');

if ($result['success']) {
    // Redirect to dashboard
}

// API Login (returns JWT)
$result = $auth->loginApi('email', 'password');
$token = $result['token'];

File Upload

use NovaFlow\Core\UploadHandler;

$upload = new UploadHandler();
$upload->allowedTypes(['image/jpeg', 'image/png'])
       ->maxSize(2097152)
       ->processImage(800, 600, 85);

$result = $upload->upload('avatar');

🗂️ Project Structure

NovaFlow/
├── app/
│   ├── controllers/      # Controllers
│   ├── models/          # Database models
│   ├── services/        # Business logic
│   ├── middleware/      # Request filters
│   ├── views/           # Templates
│   └── libraries/       # Core classes
├── config/              # Configuration
├── public/              # Public assets
├── storage/             # Logs, cache
├── tests/               # Unit tests
├── cli.php              # CLI tools
└── composer.json        # Dependencies

🧪 Testing

# Run tests
composer test

# Run specific test
./vendor/bin/phpunit tests/Unit/SecurityTest.php

🔧 CLI Commands

# Show help
php cli.php

# System health check
php cli.php --health

# List routes
php cli.php --routes

# Run queue worker
php cli.php --work

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide first.

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

📝 License

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

🙏 Acknowledgments

• Laravel (for inspiration)
• Bootstrap 5
• Font Awesome

Made with ❤️ by Mohidul Hasan