Getting started (for Developers)

Although SoftDocLinker has been developed with easy extendability in mind, it is still neccessary to have some general understanding how SoftDocLinker has been designed and how it works. This developer documentation focusses on providing basic information how SoftDocLinker can be extended to fit specific needs, what you need to know to contribute to SoftDocLinker and some advices regarding practices that you might apply to keep the code consistent.

SoftDocLinker in a nutshell

Here is a short list why extending and using SoftDocLinker is a joy for developers:

• Strict types by using TypeScript
• Adherering to a modern ECMAScript standard (ES2019) and using modern features
• THe data processing layer is strictly separated from the view logic
• Modern component based frontend (VueJS)
• Huge flexibility by using dependency injection and allowing overrides at a predefined location (InversifyJS)
• Overriding things in the first place isn't great, so almost everything that matters is observable through an event
• Strict code linting and high test coverage to prevent regressions

This leads to the fact that implementing for example an own way of fetching data can be done without requiring more effort than neccessarry.