cryental/volistx-skeleton

Volistx Framework For RESTful API Based on Laravel/Lumen

13.0.0 2024-01-04 10:59 UTC

Requires

• php: >=8.1
• ext-curl: *
• ext-json: *
• ext-pdo: *
• ext-zip: *
• cryental/laravel-stackpath: ^2.0
• guzzlehttp/guzzle: ^7.2
• interaction-design-foundation/laravel-geoip: ^3.3
• laravel/framework: ^10.0
• laravel/octane: ^1.3
• spatie/laravel-ignition: ^2.0
• volistx/framework-kernel: ^7.0

Requires (Dev)

• fakerphp/faker: ^1.21
• mockery/mockery: ^1.4.4
• nunomaduro/collision: ^7.0
• phpunit/phpunit: ^10.0
• spatie/ray: ^1.36

MIT

• Cryental
• Mostafa Samy

README

Volistx Framework For RESTful API Based on Laravel 10.x

This is a framework skeleton for Volistx API platform using Laravel PHP Framework.

Let's make some awesome thing together!

Requirements

• PHP 8.1.2 or Above
• All Required Extensions for Laravel 10.x
• Redis PHP Extension
• Swoole or OpenSwoole Extension
• MariaDB 10.5.x
• Flare Subscription for Error Monitoring (Optional) (https://flareapp.io/)

Installation

composer create-project --prefer-dist volistx/framework myproject

Usage

• Copy .env.example to .env.

• Get GeoPoint API key and put it to .env file. (Optional, only if you want to use country filter)

• Put Flare key to .env file. (Optional, only if you want to use Flare).

• Run following commands:

composer install
php artisan key:generate
php artisan migrate

Do not forget to set a cronjob for production (This is not required if you're using Swoole):

* * * * * php /path/to/artisan schedule:run

Generate an admin access key using this command:

php artisan access-key:generate

Swoole Setup

It uses Laravel Octane. You can use Swoole or OpenSwoole. You can find the installation guide here: https://laravel.com/docs/9.x/octane

Run Swoole using this command:

php artisan octane:start

If you want the Swoole server to run after reboot, add the following line to your crontab:

@reboot php artisan octane:start

For Supervisor, check following configuration:

[program:volistx-octane-worker]
directory=/path/to/
command=php artisan octane:start
numprocs=1
autostart=true
autorestart=true
startretries=3
user=www-data
redirect_stderr=true
stdout_logfile=/var/log/supervisor/%(program_name)s.log