mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 06:44:36 +01:00
47 lines
2.0 KiB
Markdown
47 lines
2.0 KiB
Markdown
# **🇬🇧 DOXA-CLI PROJECT**
|
|
|
|
##### **🇨🇿 [Czech Version](About_CZ.md)**
|
|
|
|
#### **Technical and architectural manifesto of a minimalist terminal-based note-taking application**
|
|
|
|
**Project goal:** To create a companion to the web-based [DOXA Notes](https://doxa-notes.org/), bringing the exact same philosophy into the focused environment of the command line. Built with the Go language, DOXA-CLI operates entirely locally, utilizing the identical open JSON data standard without relying on external clouds or complex frameworks.
|
|
|
|
## **1\. TECHNICAL ARCHITECTURE**
|
|
|
|
To maintain maximum speed, raw performance, and absolute minimalism, DOXA-CLI is built on solid foundations:
|
|
Language: Pure Go (Golang) ensuring native compilation, high execution speed, and zero heavy runtime dependencies.
|
|
Interface: Terminal User Interface (CLI) designed to keep the mind free from graphical clutter and focused purely on text.
|
|
Data layer: Fully compatible JSON format shared with the web version. Notes contain unique timestamps, identifiers, content, tags.
|
|
|
|
## **2\. DATA FORMAT STRUCTURE (JSON)**
|
|
|
|
Ensuring seamless interoperability with the web version, DOXA-CLI reads and writes data using the standard shared schema:
|
|
|
|
JSON
|
|
\[
|
|
{
|
|
"id":
|
|
"name": " ",
|
|
"content": " ",
|
|
"tags": \[
|
|
" "
|
|
\],
|
|
"folder": " ", // unused/empty
|
|
"created\_at": " ",
|
|
"modified\_at": " "
|
|
}
|
|
\]
|
|
|
|
## **3\. LOCAL EXECUTION & PHILOSOPHY**
|
|
|
|
**Architecture (Purely local execution)**
|
|
**Technical storage solution** \- Data resides directly on your local disk in a standardized JSON file (doxa\_notes.json), giving you absolute control with zero network latency.
|
|
**Security aspect** \- Total self-reliance. Your thoughts remain entirely on your machine.
|
|
|
|
## **License**
|
|
|
|
The application is open-source and licensed under the MIT license.
|
|
\--
|
|
"The terminal asks for nothing, distracts by nothing, and offers total control. Bring order to your thoughts through pure code." — Stoic reference from Kankys
|
|
|