diff --git a/README.md b/README.md index c148ca1..071b305 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,26 @@ PHP Sandbox =========== -*~ Improved & slimmed down fork of [Seldaek/php-console](https://github.com/Seldaek/php-console) ~* +This is a cleaned and improved continuation of [Seldaek/php-console](https://github.com/Seldaek/php-console), +forked in 2015, and as of 2018 turned into a Laravel package and published to packagist as `mightypork/php-sandbox`. -A web editor to try your PHP code. +PHP Sandbox is a web editor to try your PHP code. It allows you to run small bits of code in the context of your +Laravel application, e.g. to test functionality or verify algorithms. -This allows you to run small bits of code easily right from your browser, -in the context of your Laravel application. +There is no isolation or security built in, it is literally `eval()` with user-provided code. -There is no sandboxing or security built in, this is meant for testing in a local dev environment. -The sandbox routes can be enabled using `ENABLE_PHP_SANDBOX=true` in .env, it is disabled by default. +Absolutely DO NOT run this on a production server, and if you must, ensure it is not publicly accessible. +PHP Sandbox is meant for a local dev environment. It is disabled by default, and you can enable it using `.env` +(see the Installation section below). -**Tip:** Press Ctrl+Enter to evaluate the code -About this fork ---------------- +Screenshot +---------- -This is a fork of the original code by Seldaek (Jordi Boggiano), cleaned and turned into a Laravel package. +![screenshot](screenshot.png) -**Changes:** +**Tip:** Press Ctrl+Enter to evaluate the code -- Changed colors to look more like Sublime Text, with Monokai theme -- Slightly improved layout -- Removed info text at the bottom of the screen -- Output is now plain text, not HTML (more useful for debugging). However, some html output works too (in particular `dd()`) -- Removed "krumo", "clippy", and "Melody (bloat from the original version) -- Updated ACE to 1.2.0 with a patch to support the PHP trait keyword -- Removed the loader animation (it was broken) Installation ------------ @@ -43,7 +37,30 @@ The sandbox is available at `/sandbox`. If you wish to change the path, that can be done in the config file. You can also decide which middleware to use. + +About this fork +--------------- + +This is a fork of the original code by Seldaek (Jordi Boggiano), as it was on GitHub in 2015, cleaned and turned into a Laravel package. + +**Changes:** + +- Changed colors to look more like Sublime Text, with Monokai theme +- Slightly improved layout +- Removed info text at the bottom of the screen +- Output is now plain text, not HTML (more useful for debugging). However, some html output works too (in particular `dd()`) +- Removed "krumo", "clippy", and "Melody" (bloat from the original version) +- Updated ACE to 1.2.0 with a patch to support the PHP trait keyword +- Removed the loader animation (it was broken) + + License ------- -PHP Console is licensed under the New BSD License. +PHP Sandbox is licensed under the New BSD License. + + +Why is this not on GitHub +------------------------- + +I don't like Microsoft. diff --git a/composer.json b/composer.json index fa7845a..96aefc4 100644 --- a/composer.json +++ b/composer.json @@ -1,12 +1,12 @@ { "name": "mightypork/php-sandbox", - "description": "Web interface for testing PHP scripts and commands", + "description": "Web interface for testing PHP code (Laravel package)", "type": "library", "require": { "php": ">=5.6.0", "laravel/framework": "~5.5" }, - "license": "MIT", + "license": "BSD-3-Clause", "authors": [ { "name": "Ondřej Hruška", diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..6c236b4 Binary files /dev/null and b/screenshot.png differ