Skip to content

bootgly/bootgly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

bootgly-logo

Bootgly

Base PHP Framework for Multi Projects.

Bootgly License
Github Actions - Bootgly Workflow Github Actions - Docker Workflow

Bootgly is the first PHP framework to use the I2P (Interface-to-Platform) architecture.

Warning

🚧 DO NOT USE IT IN PRODUCTION ENVIRONMENTS. 🚧

Bootgly is in beta testing. A major version (1.0) is soon to release.

Documentation is under construction.

Table of Contents


πŸ€” About

Bootgly is a base framework for developing APIs and Apps for both CLI (Console) πŸ“Ÿ and WPI (Web) 🌐.

"Bootgly is focused on efficiency and follows a minimum dependency policy. Thanks to this approach, its unique I2P architecture, along with some uncommon code conventions and design patterns, allows Bootgly to offer superior performance while providing an easy-to-understand Code APIs."

Bootgly CLI πŸ“Ÿ

Command Line Interface

For the base CLI development, Bootgly already has the following UI components: Alert, Fieldset, Header, Menu, Progress, Table.

Bootgly WPI 🌐

Web Programming Interface

  • Interface: WPI
  • Platform: Web (IN DEVELOPMENT)

For the base Web development, Bootgly has a HTTP Server CLI, a TCP Client CLI and a TCP Server CLI.

More news may come until the release of v1.0. Stay tuned.


🟒 Boot Requirements

🀝 Compatibility

Operation System
βœ… Linux (Debian based)
❌ Windows
❔ Unix

--

βœ… = Compatible

❌ = Incompatible

❔ = Untested

Above is the native compatibility, of course it is possible to run on Windows and Unix using Docker containers.

βš™οΈ Dependencies

  • PHP 8.2+ ⚠️
  • Opcache with JIT enabled (+50% performance) πŸ‘

- Bootgly CLI πŸ“Ÿ

  • php-cli ⚠️
  • php-mbstring ⚠️
  • php-readline ⚠️

- Bootgly WPI 🌐

WPI in CLI *APIΒΉ (eg. Bootgly HTTP Server CLI):
  • * See Bootgly CLI dependencies *
WPI in Non-CLI (apache2handler, litespeed and nginx) SAPIΒ²:
  • rewrite module enabled ⚠️

--

⚠️ = Required

πŸ‘ = Recommended

ΒΉ *API = Can be Server API (SAPI), Client API (CAPI), etc.

Β² SAPI = Server API


🌱 Community

Join us and help the community.

Love Bootgly? Give our repo a star ⭐!

πŸ’» Contributing

Wait for the "contributing guidelines" to start your contribution.

πŸ›‚ Code of Conduct

Help us keep Bootgly open and inclusive. Please read and follow our Code of Conduct.

πŸ”— Social networks

πŸ’– Sponsorship

A lot of time and energy is devoted to Bootgly projects. To accelerate your growth, if you like this project or depend on it for your stack to work, consider sponsoring it.

Your sponsorship will keep this project always up to date with new features and improvements / bug fixes.


πŸš€ Getting started

πŸ“Ÿ Bootgly CLI:

Run Bootgly CLI demo
  1. See the examples in projects/Bootgly/CLI/examples/;
  2. Check the file projects/Bootgly/CLI.php;
  3. Run the Bootgly CLI demo in terminal:
php bootgly demo
Setup Bootgly CLI globally
  1. Run the Bootgly CLI setup command in terminal (with sudo):
sudo php bootgly setup
Perform Bootgly tests
  1. Check the bootstrap tests file tests/@.php;
  2. Run the Bootgly CLI test command in terminal:
bootgly test

🌐 Bootgly WPI:

Running a HTTP Server
Option 1: Non-CLI SAPI (Apache, LiteSpeed, Nginx, etc)
  1. Enable support to rewrite;
  2. Configure the WPI boot file in projects/Bootgly/WPI.boot.php file;
  3. Run the Non-CLI HTTP Server pointing to index.php.
Option 2: CLI SAPI

Directly in Linux OS (max performance):

  1. Configure the Bootgly HTTP Server script in scripts/http-server-cli file;
  2. Configure the HTTP Server API in projects/Bootgly/WPI/HTTP_Server_CLI-1.SAPI.php file;
  3. Run the Bootgly HTTP Server CLI in the terminal:
bootgly serve

or

php scripts/http-server-cli

--

or using Docker:

  1. Pull the image:
docker pull bootgly/http-server-cli
  1. Run the container in interactive mode and in the host network for max performance:
docker run -it --network host bootgly/http-server-cli

Routing HTTP Requests on the Server-side


πŸ–Ό Highlights

- Bootgly CLI πŸ“Ÿ

Bootgly CLI - initial output

Progress component (with Bar) - Render β‰ˆ7x faster than Laravel / Symfony

- Bootgly WPI 🌐

Bootgly HTTP Server CLI (wrk benchmark) - +7% faster than Workerman in the Plain Text test

HTTP Server CLI - started in monitor mode

More Screenshots, videos and details can be found in the home page of Bootgly Docs.


πŸ“ƒ License

The Bootgly is open-sourced software licensed under the MIT license.


πŸ“‘ Versioning System

Bootgly uses Semantic Versioning 2.0.