Welcome to ADE-Scheduler’s documentation !

This documentation is here to help contributors understanding how the project is built.

Quickstart

Installation

To setup your ADE Scheduler project locally, we recommend you to follow our Setup tutorial.

Documentation

• Tutorials

Note

This section contains many tutorials on how ADE Scheduler is built and how to run the project on your local machine.

Tutorials:

• Setup tutorial
  • (New) Docker setup
  • 1. Redis server
  • 2. ADE Scheduler
  • 3. Database
  • 4. ADE API
  • 5. Email
  • 6. Launch
  • 7. Contributing
• Other tutorials
  • ADE API tutorials
  • ADE Scheduler tutorials
  • Contribution tutorials
  • Database tutorials
  • Email tutorials
  • Redis server tutorials

Python modules:

• backend
  • ade_api module
  • classrooms module
  • cookies module
  • courses module
  • events module
  • manager module
  • mixins module
  • models module
  • professors module
  • resources module
  • schedules module
  • security module
  • servers module
  • track_usage module
  • uclouvain_apis module
• views
  • account module
  • admin module
  • api module
  • calendar module
  • classroom module
  • contact module
  • contribute module
  • help module
  • security module
  • utils module
  • whatisnew module

• Backend

Note

This module implements all the computationally intensive and complex functions, in a more or less optimized manner, in order to provide complete services to end users.

• Views

Note

This module makes the interface between the backend and the frontend. All requests are handled by this module.

Client modules:

• command-line tools
  • cli_api_usage module
  • cli_client module
  • cli_external_calendars module
  • cli_mails module
  • cli_plots module
  • cli_redis module
  • cli_roles module
  • cli_schedules module
  • cli_sql module
  • cli_usage module
  • cli_users module

Note

This module contains all the command-line tools built to interact with ADE-Scheduler’s data such database statistics.

Contributor Guide

We really encourage people who want to contribute in any way to do so ! There are many ways to help us:

• Pointing a problem

• Asking for a new feature

• Fixing a problem

• Adding language translations

• Fixing typos in the code

and so on…

Please take a look at our Contribution tutorials.

Index et tables

• Index

• Module Index

• Search Page