Feature/43153 documentation

.env

@@ -0,0 +1,2 @@
+COMPOSE_PROJECT_NAME=openskosapi
+COMPOSE_FILE=docker/docker-compose.yml

.gitignore

@@ -1,20 +1,15 @@
-rsync.sh
-application/configs/application.ini
-.idea
-cache/
-.sass-cache/
-public/data/export/*
-/data/uploads/
-/data/solr/
-/public/data/icons/
+###> symfony/framework-bundle ###
+/.env.local
+/.env.local.php
+/.env.*.local
+/public/bundles/
+/var/
 /vendor/
-/nbproject/
-/node_modules/
-/public/apidoc/
-/apidoc/
-/public/oaidoc/
-/application/configs/application.ini_backup.dist
-/application/configs/application_corrupted.ini
-/application/configs/application_backup.ini
-/application/configs/custom.ini
-/data/solr/data/
+api-docs.json
+###< symfony/framework-bundle ###
+
+.DS_Store
+.idea
+###> friendsofphp/php-cs-fixer ###
+/.php_cs.cache
+###< friendsofphp/php-cs-fixer ###

.php_cs

@@ -0,0 +1,16 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->exclude(['var', 'vendor'])
+    ->in(__DIR__)
+;
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR2' => true,
+        'strict_param' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        '@Symfony' => true,
+    ])
+    ->setFinder($finder)
+;

README.md

@@ -1,2 +1,36 @@
 # OpenSkos-API
 Restful API for OpenSkos
+
+## Development
+
+### Installation:
+
+* `composer install`
+* `vendor/bin/grumphp git:init` -- grump will make sure that you have no mistakes before commit ;)
+
+### Tests
+
+Test are written using [PHPSpec](https://www.phpspec.net/en/stable/manual/introduction.html)
+Run tests by: `vendor/bin/phpspec run`
+
+### Static analyser
+
+To have code strictly typed with nullability checks and etc. [Psalm](https://psalm.dev/) will help.
+Run psalm by: `vendor/bin/psalm`
+
+### Development procedure:
+* Pull latest master
+* Create feature/bug branch `feature/code-and-short-title`
+* Commit all needed changes
+* Write documentation if needed under `doc/feature-name.md`
+* Make sure you're code is covered by tests at least critical parts
+* Submit PR to github.
+* Wait for Approvals from dev-team and get ready for changes during PR discussion
+* ...?
+* Profit!
+
+## Swagger / OpenAPI documentation
+Run `composer run docs` to generate api-docs.json file to use in Swagger UI
+
+## Docker
+TODO

bin/console

@@ -0,0 +1,42 @@
+#!/usr/bin/env php
+<?php
+
+use App\Kernel;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Debug\Debug;
+
+if (false === in_array(\PHP_SAPI, ['cli', 'phpdbg', 'embed'], true)) {
+    echo 'Warning: The console should be invoked via the CLI version of PHP, not the '.\PHP_SAPI.' SAPI'.\PHP_EOL;
+}
+
+set_time_limit(0);
+
+require dirname(__DIR__).'/vendor/autoload.php';
+
+if (!class_exists(Application::class)) {
+    throw new RuntimeException('You need to add "symfony/framework-bundle" as a Composer dependency.');
+}
+
+$input = new ArgvInput();
+if (null !== $env = $input->getParameterOption(['--env', '-e'], null, true)) {
+    putenv('APP_ENV='.$_SERVER['APP_ENV'] = $_ENV['APP_ENV'] = $env);
+}
+
+if ($input->hasParameterOption('--no-debug', true)) {
+    putenv('APP_DEBUG='.$_SERVER['APP_DEBUG'] = $_ENV['APP_DEBUG'] = '0');
+}
+
+require dirname(__DIR__).'/config/bootstrap.php';
+
+if ($_SERVER['APP_DEBUG']) {
+    umask(0000);
+
+    if (class_exists(Debug::class)) {
+        Debug::enable();
+    }
+}
+
+$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
+$application = new Application($kernel);
+$application->run($input);

composer.json

@@ -0,0 +1,74 @@
+{
+    "type": "project",
+    "license": "proprietary",
+    "require": {
+        "php": "^7.3",
+        "ext-ctype": "*",
+        "ext-iconv": "*",
+        "easyrdf/easyrdf": "^0.9.1",
+        "ml/json-ld": "^1.1",
+        "sensio/framework-extra-bundle": "^5.3",
+        "symfony/console": "4.2.*",
+        "symfony/dotenv": "4.2.*",
+        "symfony/flex": "^1.1",
+        "symfony/framework-bundle": "4.2.*",
+        "symfony/property-access": "4.2.*",
+        "symfony/serializer": "4.2.*",
+        "symfony/yaml": "4.2.*",
+        "zircote/swagger-php": "^3.0"
+    },
+    "config": {
+        "preferred-install": {
+            "*": "dist"
+        },
+        "sort-packages": true
+    },
+    "autoload": {
+        "psr-4": {
+            "App\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "App\\Tests\\": "tests/"
+        }
+    },
+    "replace": {
+        "paragonie/random_compat": "2.*",
+        "symfony/polyfill-ctype": "*",
+        "symfony/polyfill-iconv": "*",
+        "symfony/polyfill-php71": "*",
+        "symfony/polyfill-php70": "*",
+        "symfony/polyfill-php56": "*"
+    },
+    "scripts": {
+        "docs": "./vendor/bin/openapi --output api-docs.json --bootstrap ./src/Swagger.php src",
+        "auto-scripts": {
+            "cache:clear": "symfony-cmd",
+            "assets:install %PUBLIC_DIR%": "symfony-cmd"
+        },
+        "post-install-cmd": [
+            "@auto-scripts"
+        ],
+        "post-update-cmd": [
+            "@auto-scripts"
+        ]
+    },
+    "conflict": {
+        "symfony/symfony": "*"
+    },
+    "extra": {
+        "symfony": {
+            "allow-contrib": false,
+            "require": "4.2.*"
+        }
+    },
+    "require-dev": {
+        "friendsofphp/php-cs-fixer": "^2.15",
+        "phpro/grumphp": "^0.15.0",
+        "phpspec/phpspec": "^5.1",
+        "phpstan/phpstan": "^0.11.6",
+        "symfony/profiler-pack": "^1.0",
+        "vimeo/psalm": "^3.2"
+    }
+}