Instruction file imported from Thorg-App/thorg-root-public (
.cursor/rules/thorg_description.mdc). Copyright stays with the author.
description: Description of Thorg project. globs: .
Thorg Project Description
What is Thorg
Thorg is a PKM (Personal Knowledge Management) tool.
Alike Dendron & Obsidian. Local First.
Implementation Notes
Thorg is implemented in Kotlin-MultiPlatform with the long term aim of being able to launch on mobile devices including IOS & Android.
In the shorter term the initial launch will be as Visual Studio code plugin (front end written in TypeScript), with Thorg running as a server on the local machine using Micronaut framework.
The core search engine is Lucene.
High Level Library structure
- asgard: lower level libraries to contain general purpose (not thorg specific) code.
- (with some exceptions such as
ValTypeis allowed to know Thorg Specific enumerations) - Strive to use commonMain where its simple to do so (future proofing for multiplatform).
- Examples:
asgardCore/asgardTestTools
- (with some exceptions such as
- thorg: level which holds Thorg specific code.
thorgCore: Key library which holds the core of the Thorg project.- Strive to use commonMain where its simple to do so (future proofing for multiplatform).
thorgCoremust NOT include server level dependencies like micronaut dependencies. Must not include UI layer dependencies.