README.md

OpenOlat

OpenOlat is a web-based e-learning platform for teaching, learning, assessment and communication, an LMS, a learning management system. OpenOlat impresses with its simple and intuitive operation.

A sophisticated modular toolkit provides course authors with a wide range of didactic possibilities. Each OpenOlat installation can be individually extended, adapted to organizational needs, and integrated into existing IT infrastructures. The architecture is designed for minimal resource consumption, scalability and security in order to guarantee high system reliability.

Table of Contents

1. Licensing
2. Ressources
3. Community
4. Developers
   • Setting up OpenOlat in Eclipse
   • Compress javascript and CSS
   • REST API
   • Automated tests
   • Experimental: setting up OpenOlat on Eclipse with an Application Server

Licensing

With regard to licensing and copyright please refer to the file LICENSE and NOTICE.TXT

Ressources

• Installation
• About OpenOlat
• Mailing list
• Issues
• OpenOlat for the community An OpenOlat instance dedicated to the community

Being a community member

We strongly suggest to participate in the OpenOlat community membership program. Even though this software is free and open source, the development and management has to be funded by someone. If you like what we do and want the product to be maintained and developed in the long run you should consider purchasing a membership: Partner program.

Developers

Setting up OpenOlat in Eclipse

This is an installation guide for developers.

Preconditions

• Check that you are using maven 3.1 or higher (mvn -V)
• Check that you have the git plugin installed in eclipse
• Check that you have git installed
• MySQL 5.6 or greater or PostreSQL 9.4

1. In Eclipse

Create a repository location (https://github.com/OpenOLAT/OpenOLAT.git) and clone the repo. Right click to clone the repository into your workspace.

If M2_REPO Eclipse variable is missing in Eclipse then execute in terminal:

mvn -Declipse.workspace=<location of your workspace> eclipse:configure-workspace

In a terminal, create the eclipse project and classpath settings by running:

mvn eclipse:clean eclipse:eclipse

Refresh the project.

You need now to create an olat.local.properties file somewhere. Copy the olat.local.properties.sample to olat.local.properties in the project root folder, adjust the file to match your setup. See the comments in the file header for more configuration options. Right click on the file src/main/java/olat.local.properties in our eclipse project to open the file properties and link it to your own olat.local.properties you created before.

Make sure the project compiled without errors. Warnings are ok. If the project did not compile, you have to fix the problems before you proceed. See Troubleshooting section below.

2. Setting up the database

Prepare database permissions and initialize the database.

For MySQL: create a user 'openolat' and a database 'openolat'