Development Guide

This manual is intended for developers and contributors who want to contribute features to Datagerry,apply patches or develop plugins.

• 1. Setup a development system
  • 1.1. Install Python
  • 1.2. Clone repository
  • 1.3. Setting up third party dependencies
  • 1.4. Modify configuration file
  • 1.5. Starting the backend and frontend
• 2. GIT Repository
  • 2.1. Branches
  • 2.2. Creating a Release
• 3. Documentation
  • 3.1. Generation
  • 3.2. Approach
• 4. Process Management
  • 4.1. adding a new service
• 5. Logging
  • 5.1. Log Levels
  • 5.2. Log Output
  • 5.3. Changing the Log Configuration
• 6. Event Handling
  • 6.1. structure of an event
  • 6.2. event routing
  • 6.3. list of event types
• 7. REST API Guidelines
  • 7.1. Instruction
  • 7.2. General
  • 7.3. Resources
  • 7.4. Responses
  • 7.5. TL;DR