chalasr/claroline

Learning management system

README

This repository provides the source code of the Claroline platform.

======= */!\ Warning if you wan't to upgrade to 13.x from a older version of Claroline read this /!*

Installation

See Claroline requirements here

1. From source

The raw installation procedure is composed of several steps that need to be executed in order (fetching php sources, installing dev dependencies, building, creating the database, etc.). Except for the configuration step, the whole process is managed through composer scripts listed in the composer.json file. For an installation from scratch, the commands would be:

git clone -b 13.x http://github.com/claroline/Claroline
cd Claroline
php bin/configure
php bin/check
composer install --no-dev --optimize-autoloader

npm install
npm run webpack

php bin/console claroline:install -vvv

Upgrade 13.x

To update your 13.x just follow this steps :

1. Update source

git pull origin 13.x
composer update --no-dev --optimize-autoloader

npm install
npm run webpack

2. Launch update script

php bin/console claroline:update -vvv

Upgrade From 12.x or older to 13.x

To update an existing installation to 13.x you must first upgrade to the latest 12.5 branch

ATTENTION : You may need to update the configuration of your web server as the new application entry point is now PROJECT_DIR/public/index.php instead of PROJECT_DIR/web/app.php.

1. go to 12.5 branch

 git fetch origin
 git checkout 12.5

2. Update source

composer update --no-dev --optimize-autoloader

npm install
npm run webpack

3. Launch update script

php bin/console claroline:update -vvv 1x.x.xx 12.5.xx

Then you can go to 13.x

4. go to 13.x branch

 git fetch origin
 git checkout 13.x

5. Update source

composer update --no-dev --optimize-autoloader

npm install
npm run webpack

mv app/config/parameters.yml config/parameters.yml
rm -rf app
rm -rf web

6. Launch update script

php bin/console claroline:update -vvv

Requirements

For a development installation, you'll need at least:

• PHP >= 7.2 with the following extensions:
  • curl
  • dom
  • fileinfo
  • gd
  • intl
  • mbstring
  • openssl
  • pdo_mysql
  • xml
  • json
  • zip
• MySQL/MariaDB >= 8.0
• composer (recent version)
• node.js >= 10
• npm >= 6

It's also highly recommended to develop on an UNIX-like OS.

For mysql >= 8.0, there is an additonal step:

    mysql -u**** -p
    set global sql_mode='';
    exit;

Development

Some assets of the platform are managed by webpack. In a development environment, they require the webpack dev server to be running. You can start it with:

npm run webpack:dev

Obviously, you'll also need a PHP-enabled web server to serve the application. Two alternatives are available.

1. Using Symfony web server (not tested)

This is the simplest way of serving the application during development. To start the server, use the command provided by the symfony local server (more details on installation and configuration here):

symfony server:start

The application will be available at http://localhost:8000.

2. Using a standalone web server (recommended)

If you want to use Apache or Nginx during development, make them serve the web directory, and access the application at http://localhost/example-site/index.php.

Note that you'll certainly face permissions issues on the following directories:

• config
• var/cache
• var/log
• var/sessions
• files
• public/uploads

All of them must be recursively writable from both the web server and the CLI. For more information on that subject, see the configuration section of the official Symfony documentation.

Usage

You can create a first admin user with:

php bin/console claroline:user:create -a

Plugins

Plugins are managed by composer like any other package in the platform. You can install or uninstall the sources of a plugin by adding or removing the package from the require section of your composer.json and running composer update, or using shortcuts like composer require ....

Once the plugin package is in your vendor directory, you can proceed to the (un-)installation using one the following commands:

php bin/console claroline:plugin:install FooBarBundle
php bin/console claroline:plugin:uninstall FooBarBundle

Important: Note that the installation and upgrade procedures of the platform described above apply only to the "standard" distribution, which comes with a fixed set of plugins. If you deviate from that set, you'll have to maintain your own composer files and perform composer update and php bin/console claroline:update accordingly.

Browser support

We recommend to use Claroline Connect with the latest version of Mozila Firefox or Chromium.

We support :

• Mozilla Firefox (latest version)
• Chromium (latest version) and Google Chrome (latest version)
• Microsoft Edge (latest version)
• Safari (latest version)

For complete list : http://caniuse.com/#feat=mutationobserver

Documentation

For user documentation, see here.