Initial commit

Author: designcise

.dockerignore

@@ -0,0 +1,5 @@
+.git
+.gitignore
+LICENSE
+README.md
+CHANGELOG.md

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,5 @@
+vendor
+.idea
+.DS_Store
+*.cache
+composer.lock

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# How to Contribute
+
+## Pull Requests
+
+1. Fork the BitFrame Framework repository;
+1. Create a new branch for each feature or improvement;
+1. Send a pull request from each feature branch against the version branch for which your fix is intended.
+
+It is very important to separate new features or improvements into separate feature branches, and to send a pull request for each branch. This allows each feature or improvement to be reviewed and merged individually.
+
+## Style Guide
+
+All pull requests must adhere to the PSR-12 standard.
+
+## Unit Testing
+
+All pull requests must be accompanied by passing unit tests and complete code coverage. The BitFrame Framework uses [PHPUnit](https://phpunit.de/) for testing.

Dockerfile

@@ -0,0 +1,27 @@
+FROM composer:latest AS composer
+
+FROM php:7.4.0-fpm AS base
+COPY --from=composer /usr/bin/composer /usr/bin/composer
+
+WORKDIR /var/www/html
+
+COPY www .
+
+# ---- Dependencies ----
+FROM base AS dependencies
+
+RUN composer install \
+        --no-suggest \
+        --ignore-platform-reqs \
+        --no-interaction \
+        --no-plugins \
+        --no-scripts \
+        --optimize-autoloader \
+        --prefer-dist
+
+# ---- Release ----
+FROM base AS release
+
+COPY --from=dependencies /var/www/html/vendor/ ./vendor
+
+COPY . .

LICENSE.md

@@ -0,0 +1,43 @@
+# License
+
+### Copyright (c) 2017-2020 Daniyal Hamid (https://designcise.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+### Third-party software used in BitFrame Microframework
+
+Portions of the BitFrame microframework either build-upon or take inspiration from the work done by:
+
+- **PHP Framework Interoperability Group**
+  * Credit For: Interoperability Interfaces
+  * Copyright (c) 2012 PHP Framework Interoperability Group
+  * MIT License
+
+- **Zend Technologies USA Inc.**
+  * Credit For: Emitter, Renderer & Http Factory Functions
+  * Copyright (c) 2015-2017 Zend Technologies USA Inc. (http://www.zend.com)
+  * New BSD license
+
+- **Oscar Otero Marzoa**
+  * Credit For: HttpFactory
+  * Copyright (c) 2018 Oscar Otero Marzoa (https://oscarotero.com)
+  * MIT License
+
+- **Guzzle Http**
+  * Credit For: Http Factory Functions
+  * Copyright (c) 2015 Michael Dowling, https://github.com/mtdowling <[email protected]>
+  * MIT License
+
+- **Phil Bennett**
+  * Credit For: Router
+  * Copyright (c) 2017 Phil Bennett <[email protected]>
+  * MIT License
+
+- **Slim Framework**
+  * Credit For: Http Decorators
+  * Copyright (c) 2015 Slim Framework
+  * MIT License

README.md

@@ -0,0 +1,92 @@
+# BitFrame PHP Microframework Boilerplate
+
+## Installation
+
+Simply clone the repo and start building your projects.
+
+### Prerequisites:
+
+- PHP 7.4.0+
+- Nginx
+- Docker Engine 1.13.0+
+
+## Directory Structure
+
+The following directory structure is recommended for development:
+
+```
+root (www)
+├── client
+│    ├── ...
+├── public
+│    ├── static
+│    └── index.php
+├── server
+│    ├── app
+│    ├── config
+│    ├── helper
+│    └── test
+├── composer.json
+└── ...
+```
+
+| Folder        | Description   |
+| ------------- |:-------------:|
+| client        | Frontend app code.   |
+| public   | Publicly accessible client-facing directory.   |
+| server        | Backend app code.   |
+
+## Quickstart
+
+### Getting Started:
+
+Navigate to the `bitframe-boilerplate` project directory and run:
+
+```
+docker-compose up
+```
+
+Then, point your browser to access the example route `/hello/test`. For example, using default nginx config in the docker container, the complete url might look something like this:
+
+```
+http://localhost:8000/hello/test
+```
+
+But this may vary depending on your server configurations.
+
+### Application Design Overview:
+
+Following would get you up to speed about the application design:
+
+- The main app code resides in the front-controller file at `public/index.php`.
+- The main app code is wrapped in a self-calling anonymous function to keep the global namespace clean.
+- The default controller (`BitFrame\Controller`) can be used as a service container, or you can inject your own as the first argument to `BitFrame\App`.
+- The handy `import` function (`YourProject\Helper\import`) is used to import different parts of the application. This helps reduce visual clutter and keep things maintainable.
+- The important directory paths are all defined as constants in `YourProject\App\Server`.
+- The router is programmed to automatically pick-up the action part of the url path and match it against a method inside the controller with the same name, suffixed with `Action`.
+- The `BitFrame\App::use()` method can be used to add middlewares. We use two middlewares in the example, one to emit the response and one for the router. 
+
+### Customizing:
+
+You may begin by customizing `root > server > composer.json`:
+
+1. Start by customizing the name, author, version, etc. for your project. If you change the package name, make sure you update it in `root > composer.json` as well under "required" dependencies.
+1. Add appropriate namespace to your app code by replacing `YourProject` with something else. Accordingly, please update namespaces throughout the project. A simply find / replace operation would help.
+1. Run `composer dumpautoload` and/or `composer update` to `root > composer.json` to see the changes.
+
+Next you can add more middleware, routes, controllers, services, etc. and start building your project. If you wish to change the directory structure, please update the constants in `YourProject\App\Server`.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+* File issues at https://github.com/designcise/bitframe/issues
+* Issue patches to https://github.com/designcise/bitframe/pulls
+
+## Documentation
+
+Complete documentation for v2.0 will be available soon on https://bitframephp.com.
+
+## License
+
+Please see [License File](LICENSE.md) for licensing information.

docker-compose.yml

@@ -0,0 +1,16 @@
+version: '3'
+services:
+  web:
+    image: nginx:latest
+    container_name: bitframex
+    ports:
+      - "8000:80"
+    depends_on:
+      - app
+    volumes:
+      - ./nginx.conf:/etc/nginx/conf.d/default.conf
+  app:
+    container_name: bitframephp
+    build: .
+    volumes:
+      - ./www:/var/www/html

nginx.conf

@@ -0,0 +1,23 @@
+server {
+  listen 80;
+  server_name 127.0.0.1;
+
+  root  /var/www/html/public;
+  index index.php;
+
+  location / {
+    try_files $uri $uri/ /index.php$is_args$args;
+  }
+
+  location ~ \.php$ {
+    fastcgi_split_path_info ^(.+\.php)(/.+)$;
+    fastcgi_pass app:9000;
+    fastcgi_index index.php;
+    include fastcgi_params;
+    fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+    fastcgi_param PATH_INFO $fastcgi_path_info;
+  }
+
+  access_log /var/log/nginx/access.log;
+  error_log  /var/log/nginx/error.log;
+}

www/composer.json

@@ -0,0 +1,26 @@
+{
+    "repositories": [
+		{
+			"type": "path",
+			"url": "server"
+		}
+	],
+    "require": {
+		"your-project/server": "*",
+		"designcise/bitframe": "2.x-dev",
+		"designcise/bitframe-fastroute": "2.x-dev",
+
+		"nyholm/psr7": "^1.2",
+        "middlewares/trailing-slash": "^1.0"
+	},
+    "require-dev": {
+		"roave/security-advisories": "dev-master",
+		"phpunit/phpunit": "^8.5",
+		"squizlabs/php_codesniffer": "3.*",
+		"phpmd/phpmd": "@stable"
+    },
+	"scripts": {
+		"style": "vendor/bin/phpcs --standard=PSR12 server",
+		"test": "vendor/bin/phpunit --configuration phpunit.xml --testsuite unit"
+	}
+}