eXeLearning

eXeLearning is an AGPL-licensed free/libre tool to create and publish open educational resources.
Explore the project »

Report a Bug · Request Feature

eXeLearning 3.0 is a modern re-implementation of the original eXeLearning authoring tool, initially created in the eXeLearning.org project in New Zealand and subsequently continued by eXeLearning.net project by the Spanish Ministry of Education, Vocational Training and Sports (MEFPD) through Cedec-INTEF.

The new code has been created within the collaboration between the MEFPD and the regional educational administrations of Andalucía and Extremadura. The revision and further developments of eXe 3.0 are carried out also with the participation of other regional administrations (Canarias, Madrid, Comunidad Valenciana and Galicia).

This version is built with modern technologies (PHP 8, Symfony 7) and provides an accessible and up-to-date user interface for creating interactive educational content.

• Creation and edition of interactive educational content
• Multiple iDevices (interactive elements)
• Multilingual support
• Exportation to various formats
• Moodle integration
• RESTful API Self-documented with Swagger
• Real-time collaborative features powered by Mercure
• Modern and accessible interface built with Bootstrap
• Multiple authentication methods (Password, CAS, OpenID Connect)
• Compatible with MySQL, PostgreSQL, and SQLite databases
• Offline installers supported via Electron and nativePHP

First install Docker if you don't have it yet. Then...

To try out eXeLearning instantly, run:

docker run -d -p 8080:8080 --name exelearning exelearning/exelearning

Then create a user:

docker exec -it exelearning php bin/console app:create-user [email protected] 1234 demouser --no-fail

This will start eXeLearning at http://localhost:8080 with your custom user.

Offline installers for Linux, Windows and macOS are also available on the Releases page. The online version is recommended for most use cases.

To deploy eXeLearning in a production environment, see:

• Overview: doc/deployment.md
• Sample Compose files: doc/deploy/README.md

See doc/development/environment.md for full setup instructions.

To start developing:

git clone https://github.com/exelearning/exelearning.git
cd exelearning
make up

This will start all services and make the app available at http://localhost:8080.

More development tools, options, and real-time collaboration info are documented in the doc/ folder.

A SCSS watcher is implemented which compiles any style automatically, without the need to launch any command. SCSS can be laid out directly in the same way as CSS.

The application follows the standard Symfony project structure, with some specific folders for managing iDevices and educational resources.

exelearning/
├── bin/                   # Symfony CLI commands
├── config/                # Configuration files
├── doc/                   # Full project documentation
├── docker/                # Docker configuration
├── public/                # Public files
├── src/                   # Application source code
│   ├── Controller/        # Controllers
│   ├── Entity/            # Entities and models
│   ├── Repository/        # Data repositories
│   └── ...
├── templates/             # Twig templates
├── tests/                 # Automated tests
├── translations/          # Translation files
├── docker-compose.yml     # Docker Compose configuration
├── Makefile               # Useful development commands
└── README.md              # This file

eXeLearning enables educators to:

1. Create interactive educational projects
2. Add different types of content using iDevices
3. Structure content with a hierarchical index
4. Export content for use in Moodle or other platforms
5. Share and collaborate on educational resources

The project supports multiple languages and uses Symfony's Translation component. Currently available:

• English (default)
• Español
• Català
• Euskara
• Galego
• Valencià
• Esperanto

For more information on translation management, see the internationalization documentation.

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

See our versioning guide for details about our Git workflow.

The project includes a Makefile to simplify development tasks:

make up               # Start Docker containers in interactive mode
make upd              # Start Docker containers in background mode
make down             # Stop and remove Docker containers
make lint             # Run the linter to check PHP code style
make fix              # Automatically fix PHP style issues
make test             # Run unit tests with PHPUnit
make test-e2e         # Run e2e tests with PHPUnit
make shell            # Open a shell inside the exelearning container
make translations     # Update translation strings
make create-user      # Create a user using the Symfony console

To see all available commands, run:

make help

The full project documentation is available in the doc directory

Distributed under the GNU AFFERO GENERAL PUBLIC LICENSE v3.0. See LICENSE for more information.

eXeLearning is a free/libre tool to create and publish open educational resources.