pack

Author: ddliu

.gitignore

@@ -1 +1,2 @@
 /vendor
+/tmp

.htaccess

@@ -0,0 +1,5 @@
+RewriteEngine on
+RewriteBase /
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.+)$ /index.php [L]

Makefile

@@ -2,7 +2,14 @@ test:
 	phpunit
 server:
 	php -S localhost:8080 -t . router.php
-build:
-	echo "TODO"
+build: zip phar
 document:
-	cd doc && mermaid *.mermaid
+	cd doc && mermaid *.mermaid
+zip:
+	mkdir -p tmp
+	zip -r tmp/ark_framework.zip . -x ".git/*" "tmp*" "*.DS_Store"
+phar:
+	mkdir -p tmp
+	box build
+clean:
+	rm -rf tmp

README.md

@@ -2,15 +2,55 @@
 
 Lightweight PHP framework.
 
+This framework aims to provide a minimal start point for your application.
+
 ## Features
 
 - Event driven
 - Small
 
+## What's Included
+
+- Application Class
+- Container (Pimple)
+- Router (FastRoute)
+
 ## Requirements
 
 - PHP 5.4
 
+## Installation
+
+### Via Composer
+
+```
+composer require ark/framework
+```
+
+### Download Zip
+
+See [Latest Release](https://github.com/arkphp/framework/releases/latest)
+
+### Download Phar
+
+See [Latest Release](https://github.com/arkphp/framework/releases/latest)
+
 ## Usage
 
-See `index.php`
+See `index.php`
+
+## Server Setup
+
+### Nginx
+
+See `nginx.conf`
+
+### Apache
+
+See .htaccess
+
+### PHP Builtin Server
+
+```
+php -S localhost:8080 -t . router.php
+```

box.json

@@ -0,0 +1,28 @@
+{
+    "alias": "ark.framework.phar",
+    "chmod": "0755",
+    "compactors": [
+        "Herrera\\Box\\Compactor\\Json",
+        "Herrera\\Box\\Compactor\\Php"
+    ],
+    "finder": [
+        {
+            "name": [
+                "LICENSE*",
+                "License*",
+                "*.php"
+            ],
+            "exclude": [
+                "phpunit",
+                "Tests",
+                "tests"
+            ],
+            "in": ["src", "vendor"]
+        }
+    ],
+    "output": "tmp/ark.framework.phar",
+    "git-version": "git_version",
+    "main": "bootstrap.php",
+    "output": "tmp/ark.framework.phar",
+    "stub": true
+}

nginx.conf

@@ -0,0 +1,19 @@
+server {
+        listen 80;
+
+        root /path/to/docroot/;
+        index index.php index.html index.htm;
+
+        server_name www.example.com;
+
+        location / {
+                try_files $uri /index.php?$query_string;;
+        }
+
+        location ~ \.php$ {
+               fastcgi_split_path_info ^(.+\.php)(/.+)$;
+               fastcgi_pass unix:/var/run/php5-fpm.sock;
+               fastcgi_index index.php;
+               include fastcgi_params;
+        }
+}

router.php

@@ -1,6 +1,6 @@
 <?php
 $path = parse_url($_SERVER["REQUEST_URI"], PHP_URL_PATH);
-if (file_exists('./'.$path)) {
+if (is_file('.'.$path) || is_dir('.'.$path)) {
     return false;  
 }