Developer guide

This chapter discusses some topics of interest to developers working on extending, customizing or maintaining frePPLe.

FrePPLe has 2 main components, and the technical documentation is structured accordingly:

• User interface and scripting, coded in Python for flexibility and agile development.
• Planning engine, coded in C++ for best performance.

• Architecture
• User interface
  • Creating an extension app
    • Prerequisites
    • Download the tutorial app
    • Register your app
    • Extend existing models with new fields
    • Define the database models
    • Create tables and fields in the database
    • Define a REST API for your models
    • Create editing forms for your models
    • Define new reports
    • Register the URLs of the new reports
    • Add the reports to the menu
    • Add demo data
    • Customize the plan generation
    • Add custom administration commands
    • Add unit tests
    • Even more information!
  • Creating an custom theme
  • Adding or customizing a report
    • General case
    • Using the frePPLe generic report
  • Translating the user interface
  • Unit tests
• Planning engine
  • Class diagram
  • Planning algorithm
  • Cluster and level algorithm
  • Extension modules
  • Unit tests
• Security