mirror of
https://github.com/MarginaliaSearch/MarginaliaSearch.git
synced 2025-02-23 21:18:58 +00:00
77ccab7d80
This makes index complete in the sense that you can deploy an index instance and build a complete separate application on top of it, without having to go through the Marginalia-laden search service. |
||
|---|---|---|
| .. | ||
| api | ||
| common | ||
| features-convert | ||
| features-crawl | ||
| features-index | ||
| features-search | ||
| libraries | ||
| process-models | ||
| processes | ||
| services-core | ||
| services-satellite | ||
| tools | ||
| readme.md | ||
Code
This is a pretty large and diverse project with many moving parts.
You'll find a short description in each module of what it does and how it relates to other modules. The modules each have names like "library" or "process" or "feature". These have specific meanings. See doc/module-taxonomy.md.
Overview
A map of the most important components and how they relate can be found below.
Services
- core services "macroservices", stateful, memory hungry doing heavy lifting.
- satellite services "microservices", stateless providing additional functionality.
-
- api - public API
- an internal API
Processes
Processes are batch jobs that deal with data retrieval, processing and loading.
Tools
Features
Features are relatively stand-alone components that serve some part of the domain. They aren't domain-independent, but isolated.
Libraries and primitives
Libraries are stand-alone code that is independent of the domain logic.