Updated installation instructions and refactored the exercise creation mecanism.

.gitignore

@@ -1,2 +1,2 @@
 var/
-.*
+*~

INSTALL.md

@@ -0,0 +1,27 @@
+1. Clone the repo
+
+    git clone https://github.com/fracz/git-exercises.git
+	cd git-exercises
+
+2. Adjust the environment variables
+
+	cd docker
+    cp env.example .env
+
+	Change the values of those variables according to your domain specifics :
+
+	DOMAIN_NAME=<Your domain name> # used in the cloning URL
+	SITE_ADMIN_NAME=<Your admin name> # used as the committer name for given commits
+	SITE_ADMIN_EMAIL=<Your admin email> # used as the committer email for given commits
+
+	Change the value of this variable if you wish to use a different repo as a source of exercises :
+
+	GIT_REPO=<URL to a repo of questions>
+
+3. Run with docker-compose
+
+    docker-compose up -d
+
+4. The web app should be available at https://$DOMAIN_NAME/
+
+5. The exercise repo should be available at git://$DOMAIN_NAME/git/exercises.git

README.md

@@ -3,3 +3,76 @@
 This repository contains the source code of the [git-exercises](https://gitexercises.fracz.com/) platform for practising git.
 
 ![git-exercises](frontend/public/images/intro.gif)
+
+## Overview
+
+This project consists of two docker images: mysql and an apache server.
+
+## Setup
+
+*Windows 10*:
+```
+Docker desktop community 2.3.0.3
+    - docker-compose version 1.25.5, build 8a1c60f6
+    - Docker version 19.03.8, build afacb8b
+MySQL Workbench 8.0
+```
+
+*Ubuntu 18.04.5*:
+```
+docker-compose version 1.17.1, build unknown
+Docker version 19.03.6, build 369ce74a3c
+mysql-client-core-5.7
+```
+
+## Configuration
+
+The only file you need to update is `docker/.env`
+
+## How to build
+
+In directory `/docker` run
+```
+docker-compose build
+```
+
+Make sure the default branch of your repo is `verifications`
+
+## How to run
+
+In directory `/docker` run
+```
+docker-compose run
+```
+
+## Database schema initialization
+
+First time you need to run `backend/schema/gitexercises.sql`
+
+To execute these instructions do
+
+```bash
+# login to mysql running in docker container
+mysql -h localhost -P 3306 --protocol=tcp -u root 
+# in mysql shell 
+CREATE DATABASE <DB_NAME as defined in docker/.env>;
+USE <DB_NAME as defined in docker/.env>;
+# run the sql file
+source 'backend/schema/gitexercises.sql'
+
+```
+
+## Start exercising
+
+Assuming you run on localhost, this is how you start with exercise 1
+
+```bash
+git clone http://localhost/git/exercises.git git-exercises
+cd git-exercises
+./configure.sh
+git start
+```
+
+## Adding new exercises
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)

backend/.gitignore

@@ -1,5 +1,4 @@
 vendor/
 composer.phar
-config.php
 *.log
 *.bak

backend/composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "git-exercises",
+    "name": "fracz/git-exercises",
     "require": {
         "php": ">=5.5",
         "slim/slim": "2.6.2",

backend/config.php

@@ -0,0 +1,10 @@
+<?php
+/*
+ * Copy this file into config.php and adjust values below to match your environment.
+ */
+
+define('DB_HOST', getenv('DB_HOST'));
+define('DB_NAME', getenv('DB_NAME'));
+define('DB_USER', getenv('DB_USER'));
+define('DB_PASSWORD', getenv('DB_PASSWORD'));
+define('DOMAIN_NAME', getenv('DOMAIN_NAME'));

backend/controllers/CommitterController.php

@@ -17,7 +17,7 @@ public function getAction($id)
             $result['passedExercises'] = $this->getApp()->committerService->getPassedExercises($id);
             $result['nextExercise'] = $this->getApp()->committerService->suggestNextExercise($result['passedExercises']);
         } else {
-            $result['nextExercise'] = 'master';
+            $result['nextExercise'] = 'main';
             $result['passedExercises'] = [];
         }
         return $result;

backend/hook/AbstractVerification.php

@@ -21,14 +21,6 @@ public function verify()
         $this->doVerify();
     }
 
-    public function getSolution()
-    {
-        $solutionFile = __DIR__ . '/hints/' . get_class($this) . '-solution.txt';
-        if (file_exists($solutionFile)) {
-            return file_get_contents($solutionFile);
-        }
-    }
-
     protected abstract function doVerify();
 
     protected function ensure($condition, $errorMessage, array $formatVars = [])

backend/hook/hook.php

@@ -8,14 +8,16 @@
 ini_set("error_log", __DIR__ . "/../data/logs/hook-error.log");
 
 require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/../config.php';
 
 use GitExercises\hook\utils\ConsoleUtils;
 use GitExercises\hook\utils\GitUtils;
+use GitExercises\services\ExerciseUtils;
 use GitExercises\services\CommitterService;
 use GitExercises\services\GamificationService;
 use GitExercises\services\ShortIdService;
 
-define('DOMAIN', 'https://gitexercises.fracz.com');
+define('DOMAIN', 'http://' . DOMAIN_NAME);
 
 $branch = $argv[1];
 $oldRev = $argv[2];
@@ -35,8 +37,9 @@
 $shortCommiterId = (new ShortIdService())->getShort($committerId);
 $gamificationService = new GamificationService($committerId);
 
-$possibleCommand = ucfirst(AbstractVerification::dashToCamelCase($exercise));
+$possibleCommand = ucfirst($exercise);
 $command = 'GitExercises\\hook\\commands\\' . $possibleCommand . 'Command';
+
 if (class_exists($command)) {
     (new $command())->execute($committerId);
 } else {
@@ -55,7 +58,7 @@
         try {
             $verifier->verify();
             echo ConsoleUtils::green('PASSED') . PHP_EOL;
-            $solution = $verifier->getSolution();
+            $solution = ExerciseUtils::getExerciseSolution($exercise);
             if ($solution) {
                 echo PHP_EOL . ConsoleUtils::pink('The easiest solution:') . PHP_EOL . trim($solution) . PHP_EOL . PHP_EOL;
             }

backend/hook/utils/GitUtils.php

@@ -48,9 +48,9 @@ public static function getCommitDate($commitId)
      * @param $commitId
      * @return array indexed by filenames, values are operations (M, A, D)
      */
-    public static function getChangedFiles($commitId)
+    public static function getChangedFiles($commitId, $secondCommitId="")
     {
-        exec("git diff-tree --no-commit-id --name-status -r $commitId", $changes);
+        exec("git diff-tree --no-commit-id --name-status -r $commitId $secondCommitId", $changes);
         $changedFiles = [];
         foreach ($changes as $change) {
             $data = explode("\t", $change);
@@ -83,7 +83,7 @@ public static function checkIgnore($commitId, $filename)
     {
         exec("git checkout -q $commitId");
         exec("git check-ignore -v $filename", $result, $status);
-        exec("git checkout -q master");
+        exec("git checkout -q main");
         if ($status) {
             return false;
         }

backend/scripts/exercise-tester.php

@@ -29,11 +29,11 @@
 if (!is_dir($repo)) {
     system('cd ' . __DIR__ . ' && git clone ' . REPO_URL . ' ' . LOCAL_DIR_NAME);
     run('git checkout verifications');
-    run('git branch -D master');
+    run('git branch -D main');
     run('git remote rm origin');
     run('git remote add origin ' . VERIFICATION_URL);
     run('git fetch origin');
-    run('git checkout master');
+    run('git checkout main');
     run('configure.sh');
 }