Merge branch 'release/0.1.0'

adam-paterson · adam-paterson · commit a83af42aecf1 · 2017-02-16T15:55:56.000Z
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/kickass
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,13 @@
+sudo: required
+services:
+  - docker
+
+env:
+  DOCKER_COMPOSE_VERSION: 1.7.1
+
+script:
+  - docker-compose --file docker-compose-build.yml up -d --build
+  - docker-compose --file docker-compose-build.yml run web nginx -t
+  - docker-compose --file docker-compose-build.yml run fpm php -v
+  - docker-compose --file docker-compose-build.yml run cli php -v
+  - docker-compose --file docker-compose-build.yml run cli kickass-installer
diff --git a/7.1-cli/Dockerfile b/7.1-cli/Dockerfile
@@ -0,0 +1,45 @@
+# FPM, PHP 7.1, KickAssCommerce compatible container.
+
+FROM php:7.1-cli
+
+MAINTAINER Adam Paterson <hello@adampaterson.co.uk>
+
+# Install PHP extension dependancies
+RUN apt-get update \
+  && apt-get install -y \
+    libicu-dev \
+    libmcrypt-dev \
+    libxslt1-dev \
+    zlib1g-dev \
+    git
+
+# Install required PHP extensions
+RUN docker-php-ext-install \
+  intl \
+  mbstring \
+  mcrypt \
+  xsl \
+  zip \
+  soap
+
+# Install PHP7 compatible version of xdebug
+RUN pecl install -o -f xdebug-2.4.0
+
+# Install composer
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+
+# Define volume for caching composer packages
+VOLUME /root/.composer/cache
+
+# Add executables and config
+ADD bin/* /usr/local/bin/
+ADD etc/php.ini /usr/local/etc/php/conf.d/zz-kickass.ini
+ADD etc/php-xdebug.ini /usr/local/etc/php/conf.d/zz-xdebug.ini
+
+# Define default environment variables
+ENV PHP_MEMORY_LIMIT 2G
+ENV PHP_ENABLE_XDEBUG false
+ENV APP_ROOT /var/www/kickass
+
+ENTRYPOINT ["/usr/local/bin/docker-environment"]
+CMD ["bash"]
diff --git a/7.1-cli/bin/docker-environment b/7.1-cli/bin/docker-environment
@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Ensure our Kickass directory exists
+mkdir -p $APP_ROOT
+chown www-data:www-data $APP_ROOT
+
+# Configure PHP
+[ ! -z "${PHP_MEMORY_LIMIT}" ] && sed -i "s/!PHP_MEMORY_LIMIT!/${PHP_MEMORY_LIMIT}/" /usr/local/etc/php/conf.d/zz-kickass.ini
+
+[ "$PHP_ENABLE_XDEBUG" = "true" ] && \
+    docker-php-ext-enable xdebug && \
+    echo "Xdebug is enabled"
+
+exec "$@"
diff --git a/7.1-cli/bin/kickass-installer b/7.1-cli/bin/kickass-installer
@@ -0,0 +1,15 @@
+#!/bin/bash
+
+if [ ! -f "$APP_ROOT/composer.json" ]; then
+    echo "Creating KickAssCommerce ($KICKASS_VERSION) project"
+
+    composer create-project \
+        kickasscommerce/kickasscommerce=$KICKASS_VERSION \
+        --no-interaction \
+        $APP_ROOT
+else
+    echo "KickAssCommerce installation found in $APP_ROOT, installing composer dependencies"
+    composer --working-dir=$APP_ROOT install
+fi
+
+echo "Installation complete"
diff --git a/7.1-cli/etc/php-xdebug.ini b/7.1-cli/etc/php-xdebug.ini
@@ -0,0 +1,10 @@
+; Xdebug settings are only relevent if the Xdebug module is loaded
+
+xdebug.remote_enable = 1
+xdebug.remote_connect_back = 1
+xdebug.remote_port = 9000
+
+xdebug.scream = 0
+xdebug.show_local_vars = 1
+
+xdebug.idekey = PHPSTORM
diff --git a/7.1-cli/etc/php.ini b/7.1-cli/etc/php.ini
@@ -0,0 +1 @@
+memory_limit = !PHP_MEMORY_LIMIT! ; Variable: PHP_MEMORY_LIMIT
diff --git a/7.1-fpm/Dockerfile b/7.1-fpm/Dockerfile
@@ -0,0 +1,41 @@
+# FPM, PHP 7.1, KickAssCommerce compatible container.
+
+FROM php:7.1-fpm
+
+MAINTAINER Adam Paterson <hello@adampaterson.co.uk>
+
+# Install PHP extension dependancies
+RUN apt-get update \
+  && apt-get install -y \
+    libicu-dev \
+    libmcrypt-dev \
+    libxslt1-dev \
+    zlib1g-dev
+
+# Install required PHP extensions
+RUN docker-php-ext-install \
+  intl \
+  mbstring \
+  mcrypt \
+  xsl \
+  zip
+
+# Install PHP7 compatible version of xdebug
+RUN pecl install -o -f xdebug-2.5.0
+
+# Define volume for caching composer packages
+VOLUME /roo/.composer/cache
+
+# Add executables and config
+ADD bin/docker-environment /usr/local/bin/
+ADD etc/php.ini /usr/local/etc/php/conf.d/zz-kickass.ini
+ADD etc/php-xdebug.ini /usr/local/etc/php/conf.d/zz-xdebug.ini
+ADD etc/php-fpm.conf /usr/local/etc/
+
+# Define default environment variables
+ENV PHP_MEMORY_LIMIT 2G
+ENV PHP_ENABLE_XDEBUG false
+ENV APP_ROOT /var/www/kickass
+
+ENTRYPOINT ["/usr/local/bin/docker-environment"]
+CMD ["php-fpm", "-F"]
diff --git a/7.1-fpm/bin/docker-environment b/7.1-fpm/bin/docker-environment
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Configure PHP
+[ ! -z "${PHP_MEMORY_LIMIT}" ] && sed -i "s/!PHP_MEMORY_LIMIT!/${PHP_MEMORY_LIMIT}/" /usr/local/etc/php/conf.d/zz-kickass.ini
+
+[ "$PHP_ENABLE_XDEBUG" = "true" ] && \
+    docker-php-ext-enable xdebug && \
+    echo "Xdebug is enabled"
+
+exec "$@"
diff --git a/7.1-fpm/etc/php-fpm.conf b/7.1-fpm/etc/php-fpm.conf
@@ -0,0 +1,23 @@
+[global]
+
+error_log = /proc/self/fd/2
+daemonize = no
+
+[www]
+access.log = /proc/self/fd/2
+
+user = www-data
+group = www-data
+
+listen = [::]:9000
+
+pm = dynamic
+pm.max_children = 10
+pm.start_servers = 4
+pm.min_spare_servers = 2
+pm.max_spare_servers = 6
+
+clear_env = no
+
+; Ensure stdout and stderr are sent to the main error log
+catch_workers_output = yes
diff --git a/7.1-fpm/etc/php-xdebug.ini b/7.1-fpm/etc/php-xdebug.ini
@@ -0,0 +1,10 @@
+; Xdebug settings are only relevent if the Xdebug module is loaded
+
+xdebug.remote_enable = 1
+xdebug.remote_connect_back = 1
+xdebug.remote_port = 9000
+
+xdebug.scream = 0
+xdebug.show_local_vars = 1
+
+xdebug.idekey = PHPSTORM
diff --git a/7.1-fpm/etc/php.ini b/7.1-fpm/etc/php.ini
@@ -0,0 +1 @@
+memory_limit = !PHP_MEMORY_LIMIT! ; Variable: PHP_MEMORY_LIMIT
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,22 @@
+# Changelog
+
+All Notable changes to `KickAssDocker` will be documented in this file.
+
+Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
+
+## NEXT - 2017-02-15
+
+### Added
+- Initial commit
+
+### Deprecated
+- Nothing
+
+### Fixed
+- Nothing
+
+### Removed
+- Nothing
+
+### Security
+- Nothing
diff --git a/CONDUCT.md b/CONDUCT.md
@@ -0,0 +1,74 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at `hello@adampaterson.co.uk`. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+We accept contributions via Pull Requests on [Github](https://github.com/KickAssCommerce/KickAssDocker).
+
+
+## Pull Requests
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2017 KickAss Commerce
+
+> 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.
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,43 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+
+Describe your changes in detail.
+
+## Motivation and context
+
+Why is this change required? What problem does it solve?
+
+If it fixes an open issue, please link to the issue here (if you write `fixes #num`
+or `closes #num`, the issue will be automatically closed when the pull is accepted.)
+
+## How has this been tested?
+
+Please describe in detail how you tested your changes.
+
+Include details of your testing environment, and the tests you ran to
+see how your change affects other areas of the code, etc.
+
+## Screenshots (if appropriate)
+
+## Types of changes
+
+What types of changes does your code introduce? Put an `x` in all the boxes that apply:
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+
+Go over all the following points, and put an `x` in all the boxes that apply.
+
+Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our [continuous integration](http://www.phptherightway.com/#continuous-integration) server to make sure your [tests and code style pass](https://help.github.com/articles/about-required-status-checks/).
+
+- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
+- [ ] My pull request addresses exactly one patch/feature.
+- [ ] I have created a branch for this patch/feature.
+- [ ] Each individual commit in the pull request is meaningful.
+- [ ] I have added tests to cover my changes.
+- [ ] If my change requires a change to the documentation, I have updated it accordingly.
+
+If you're unsure about any of these, don't hesitate to ask. We're here to help!
diff --git a/README.md b/README.md
diff --git a/docker-compose-build.yml b/docker-compose-build.yml
diff --git a/docker-compose.yml b/docker-compose.yml
diff --git a/nginx/Dockerfile b/nginx/Dockerfile
diff --git a/nginx/bin/docker-environment b/nginx/bin/docker-environment
diff --git a/nginx/etc/vhost.conf b/nginx/etc/vhost.conf

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+memory_limit = !PHP_MEMORY_LIMIT! ; Variable: PHP_MEMORY_LIMIT`