Welcome to IdeaLoom’s documentation!

Installation and administration

• Installing IdeaLoom
  • Prerequisites
  • Installing the application
  • Setting initial parameters
  • Getting the server ready
  • Running
  • Final production tasks
  • Updating an environment
• IdeaLoom Configuration files
  • Rationale and history
  • The enriched .rc file format
  • Migrating to the new configuration system
• Setting-up backups for an IdeaLoom server
  • Installing Borg Backup
  • Using
  • Restoring
• Python Requirements

Stack and architecture

• The IdeaLoom technology stack
  • Backend
  • Frontend
  • Templating, HTML and CSS
  • Build system
  • Translation
  • Operations
• Permissions and roles architecture
  • How the roles & permissions system works in IdeaLoom
  • Explanation of each permission
• Group and panels architecture
• Data interdependence in the frontend
  • Future work

• Target login and authentication flowchart

Developping and contributing to IdeaLoom

• How to perform common developper tasks
  • Add a new model (frontend and backend)
  • Download a copy of a remote database to develop locally
  • Run tests
  • Python shell with database connection
  • Raw sql connection
• Writing documentation for IdeaLoom
  • Cheat sheet
• Contributing to IdeaLoom translations
  • Transifex
  • Contributing translation
  • Updating translation files
  • The translation workflow
• Building a docker image
• Writing tests
  • Overview
  • Front-end
  • Back-end
  • Integration
• Example debate fixture
• Development: Creating a new model class tutorial
  • ORM mapping
  • DiscussionBoundBase protocol
  • Extra collections
  • Duplicate handling
  • CRUD permissions
  • ViewDefs
  • Initialization
  • Migration and declaration
  • Frontend model

APIs

• IdeaLoom’s routes and APIs
  • Cornice RESTful services
  • Traversal API
  • Static routes
• Piwik Reporting API
• Analytics Events

• The CATALYST Interchange format (CIF) (not fully functional since the migration to postgres 2016-06-30)

Backend class reference

• assembl
  • assembl package
    • Subpackages
      • assembl.auth package
      • assembl.lib package
      • assembl.models package
      • assembl.nlp package
      • assembl.scripts package
      • assembl.semantic package
      • assembl.tasks package
      • assembl.tests package
      • assembl.tweens package
      • assembl.view_def package
      • assembl.views package
    • Submodules
      • assembl.conftest module
      • assembl.fabfile module
      • assembl.maintenance module
      • assembl.validation module
    • Module contents

Frontend class reference

• API
  • app
    • common
    • internal_modules
    • models
    • routeManager
    • router
    • tests
    • objects
    • utils
    • views

Indices and tables

• Index

• Module Index

• Search Page