blueprintau/lucent

There is no license information available for the latest version (v0.260620.9) of this package.

Lucent PHP web framework

v0.260620.9 2026-06-20 09:15 UTC
Deleted by maintainer on 2026-08-10 09:47:06 UTC

Requires

• ext-curl: *
• ext-fileinfo: *
• ext-mysqli: *
• ext-pdo: *
• ext-zip: *

Requires (Dev)

• phpunit/phpunit: ^12.0

Unknown License

Published on Packagist.org on 2026-08-10 08:58 UTC

README

Lucent is a lightweight PHP framework designed for building APIs with minimal overhead. It offers an elegant, intuitive syntax that will feel familiar to developers with experience in Laravel or Spring Boot.

Lucent provides a streamlined approach to building PHP APIs with:

• Simple routing with REST
• Database abstraction with support for MySQL and SQLite
• Model-based ORM with relationships
• Route Model Binding
• Rules & Validation
• Middleware support
• Comprehensive PSR-3 compliant logging
• PSR-7/15/17 HTTP messages
• PSR-18 HTTP client
• Dependency Injection Container
• CLI tools for development and maintenance
• File System
• UUID's
• Exception & Error handling

Installing and Updating

Installation

Create a new Lucent project using Composer:

composer create-project blueprintau/lucent myapp

Then start the development server:

cd myapp
vendor/bin/lucent serve

By default the server runs on port 8080. Pass --port=9000 to use a different port:

vendor/bin/lucent serve --port=9000

Alternatively, add Lucent to an existing project:

composer require blueprintau/lucent

Updating Lucent

To update Lucent to the latest version:

composer update blueprintau/lucent

Deploying Your Project

Lucent includes a built-in deployment system that allows you to deploy and rollback your project directly from the CLI. It works with any zip-based source — GitHub, Gitea, S3, or any URL that returns a zip file.

Configuration

Add the following to your .env file:

DEPLOY_URL=https://api.github.com/repos/your-org/your-repo/zipball/master
DEPLOY_TOKEN=your_personal_access_token

For GitHub private repositories, generate a Access Token with repo scope at https://github.com/settings/tokens, then use the API URL format above with the following headers automatically applied by Lucent:

Authorization: Bearer {token}

Accept: application/vnd.github+json

X-GitHub-Api-Version: 2022-11-28

Deploying the Latest Version

vendor/bin/lucent deploy latest

This will:

1. Download the zip from DEPLOY_URL
2. Back up your current project to storage/backups/{timestamp}.zip
3. Extract the new version over your project

The following paths are never touched during a deploy:

• .env — your environment config
• vendor/ — your Composer dependencies
• storage/ — your logs, uploads, and temp files

Rolling Back

vendor/bin/lucent deploy rollback

This will:

1. Clean the current project (preserving .env, vendor/, storage/backups, storage/temp, and logs)
2. Restore the most recent backup zip
3. Remove the used backup

Project Structure

After installation, your project will have the following structure:

myapp/
├── App/
│   ├── Commands/
│   ├── Controllers/
│   ├── Models/
│   └── Rules/
├── commands/              # CLI command files (auto-loaded)
├── routes/                # Route files (auto-loaded)
├── public/
│   └── index.php
├── storage/
├── logs/
├── vendor/
│   └── blueprintau/
│       └── lucent/        # The framework
├── .env
└── composer.json

Configuration

Configure your database connection and other settings in the .env file:

DB_USERNAME=root
DB_PASSWORD=
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=lucent
DB_DRIVER=mysql

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

Lucent is open-sourced software licensed under the MIT license.