initial release v1.0.0

Author: mhdcodes

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2

.gitignore

@@ -0,0 +1,62 @@
+
+# Created by https://www.gitignore.io/api/linux,windows,composer,visualstudiocode
+
+### Composer ###
+composer.phar
+/vendor/
+
+# Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
+# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
+# composer.lock
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+
+.phpintel/
+# End of https://www.gitignore.io/api/linux,windows,composer,visualstudiocode
+
+.env
+.phpunit.result.cache
+.php_cs.cache

.travis.yml

@@ -0,0 +1,13 @@
+language: php
+php:
+  - '7.0'
+  - '7.1'
+  - '7.2'
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+before_script:
+    - composer install
+script: composer test

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 PHPJuice
+
+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.

README.md

@@ -0,0 +1,56 @@
+# OpenCF
+
+OpenCF - a PHP Item-based Collaborative Filtering Engine.
+  
+## Requirements
+OpenCF Package requires PHP 5.6+
+> **WARNING:** This library may not function correctly on PHP < 5.6.
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+
+### Installing
+
+The supported way of installing the OpenCF Package is via Composer.
+
+```sh
+$ composer require opencf/opencf
+```
+
+## Usage
+
+OpenCF Package is designed to be very simple and straightforward to use. All you have to do is to load rating data, then predict future ratings based on the training set provided.
+
+
+## Running the tests
+
+you can easly run tests using composer
+
+``` bash
+$ composer test
+```
+
+## Built With
+
+* [PHP](http://www.php.net) - The programing language used
+* [Composer](https://getcomposer.org) - Dependency Management
+* [PHPUnit](https://phpunit.de/) - Programmer-oriented testing framework for PHP.
+
+## Contributing
+
+Please read [CONTRIBUTING](https://gitlab.com/opencf/opencf/wikis/) for details.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://gitlab.com/opencf/opencf/tags). 
+
+## Authors
+
+- [ElHaouari Mohammed](https://github.com/elhaouari-mohammed)
+
+See also the list of [contributors](https://gitlab.com/opencf/opencf/graphs/master) who participated in this project.
+
+## License
+This project is licensed under the MIT License - see the [LICENSE.md](https://gitlab.com/opencf/opencf/blob/master/LICENSE) file for details

composer.json

@@ -0,0 +1,44 @@
+{
+    "name": "opencf/opencf",
+    "description": "OpenCF - an Item-based Collaborative Filtering Engine.",
+    "keywords": [
+        "recommendation",
+        "recommender",
+        "collaborative filtering"
+    ],
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Elhaouari Mohammed",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": ">=5.6"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "5.7",
+        "symfony/var-dumper": "3.4.x-dev",
+        "phpstan/phpstan": "^0.12.28",
+        "squizlabs/php_codesniffer": "*"
+    },
+    "autoload": {
+        "psr-4": {
+            "OpenCF\\OpenCF\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "OpenCF\\OpenCF\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "./vendor/bin/phpunit --colors=always --configuration phpunit.xml.dist",
+        "fix-cs": [
+            "php-cs-fixer fix src --rules=@Symfony,@PSR2",
+            "php-cs-fixer fix tests --rules=@Symfony,@PSR2"
+        ],
+        "analyse": "vendor/bin/phpstan analyse src tests"
+    }
+}