From fa06b1f2ea479c5f280aa670fbc88126c946ea04 Mon Sep 17 00:00:00 2001 From: Paul Dragoonis Date: Sun, 7 Feb 2016 19:16:09 +0000 Subject: [PATCH] README update --- README.md | 90 +------------------------------------------------------ 1 file changed, 1 insertion(+), 89 deletions(-) diff --git a/README.md b/README.md index d6aee86..88446a5 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,10 @@ PPI Skeleton Application ======================= -Introduction ------------- -This is a simple, skeleton application using the PPI MVC layer and module -systems. This application is meant to be used as a starting place for those -looking to get their feet wet with PPI. - - What is PPI ? -------------- -PPI is the the PHP Interoperability Framework. It provides an equal and open platform to empower PHP developers to -pick the best tools from the best PHP frameworks - -PPI bootstraps framework components for you from the top frameworks such as ZendFrameworks2, Symfony2, Laravel4, -FuelPHP, Doctrine2 - - -Installation using Vagrant and Ansible ---------------------------- - -Before you can run vagrant you’ll need to install a few system dependencies. - -# osx -brew install vagrant ansible node -# linux (ubuntu) -sudo apt-get install vagrant ansible node -# linux (centos) -sudo yum install vagrant ansible node - -### Vagrant server - -This project supports a basic [Vagrant](http://docs.vagrantup.com/v2/getting-started/index.html) configuration with -an inline shell provisioner to run the Skeleton Application in a [VirtualBox](https://www.virtualbox.org/wiki/Downloads). - -1. Run vagrant up command: `$ vagrant up` -2. Visit [http://localhost](http://localhost) in your browser - -Look in [Vagrantfile](Vagrantfile) for configuration details. - -### Apache setup - -To setup apache, setup a virtual host to point to the public/ directory of the -project and you should be ready to go! It should look something like below: - - - ServerName skeletonapp.ppi - DocumentRoot "/var/www/skeleton/public" - SetEnv PPI_ENV dev - SetEnv PPI_DEBUG true - - - AllowOverride All - Allow from all - DirectoryIndex index.php - Options Indexes FollowSymLinks - - RewriteEngine On - RewriteCond %{REQUEST_FILENAME} !-d - RewriteCond %{REQUEST_FILENAME} !-f - RewriteRule ^ index.php [L] - - - - -### Nginx setup - -To setup nginx, open your `/path/to/nginx/nginx.conf` and add an -[include directive](http://nginx.org/en/docs/ngx_core_module.html#include) below -into `http` block if it does not already exist: - - server { - listen 80; - server_name skeletonapp.ppi; - root /var/www/skeleton/public; - index index.php; - - location / { - try_files $uri /index.php$is_args$args; - } - - location ~ \.php$ { - fastcgi_pass 127.0.0.1:9000; - include fastcgi_params; - fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; - fastcgi_param HTTPS off; - } - } - -Restart the nginx, now you should be ready to go! - +PPI is a framework delivery engine. Using the concept of microservices, it lets you choose which parts of frameworks you wish to use on a per-feature basis. As such each feature makes its own independent decisions, allowing you to pick the best tools from the best PHP frameworks. -Documentation -------------- [Visit the documentation](http://docs.ppi.io/latest) Contributing