mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 14:44:36 +01:00
116 lines
4.7 KiB
Markdown
116 lines
4.7 KiB
Markdown
# 🇬🇧 DOXA Notes PROJECT
|
|
|
|
##### 🇨🇿 [Czech Version](#czech-version)
|
|
|
|
#### Technical and architectural manifesto of a minimalist note-taking application
|
|
|
|
**Project goal:** To create an absolutely independent, secure and minimalist environment for storing people's
|
|
thoughts, notes and life reflections. In accordance with the liberal principles of self-sufficiency, the application does not rely on
|
|
third-party cloud databases, but operates fully locally with the open JSON format on its own server
|
|
backend.
|
|
|
|
## 1. TECHNICAL ARCHITECTURE
|
|
To maintain maximum speed, code purity and zero external dependencies, the application will be built on a pure
|
|
web standard (so-called Vanilla stack):
|
|
|
|
Frontend: Semantic HTML5 for structure, CSS3 for a minimalist interface that does not burden the mind with colorful chaos.
|
|
|
|
Client logic: Pure JavaScript (ES6+) without frameworks (React/Vue). Everything runs natively in the browser.
|
|
|
|
Data layer: Standardized JSON format. Notes are structured as an array of objects, where each
|
|
item has a unique identifier, timestamp, and text content.
|
|
|
|
Desktop applications for Linux and Windows are packaged in AppImage installers - Linux and exe (Windows).
|
|
|
|
## 2. DATA FORMAT STRUCTURE (JSON)
|
|
Data purity ensures that your thoughts will be readable even in twenty years on any device. The basic schema of one note is as follows:
|
|
|
|
```json
|
|
{
|
|
"notes": [
|
|
{
|
|
"id": "1719147600000",
|
|
"title": "Morning reflection",
|
|
"content": "Digital illusion denied today. Mind is calm and steady.",
|
|
"created_at": "2026-06-23T08:00:00Z",
|
|
"updated_at": "2026-06-23T08:00:00Z"}
|
|
|
|
]}
|
|
```
|
|
## 3. VPS DEPLOYMENT STRATEGY (DOXA.LUKAN.CZ)
|
|
Since the application (web version) will run on its own virtual private network (VPS) with the architecture:
|
|
|
|
### **Architecture (Purely client-side)**
|
|
|
|
**Technical data storage solution** - The application runs on a subdomain, but the data is stored in the browser (LocalStorage / IndexedDB) with option to manually export/import JSON file.
|
|
|
|
**Security aspect** - Absolute security. No data leaves your browser to the network.
|
|
|
|
## License
|
|
|
|
The application is open-source and licensed under the MIT license.
|
|
|
|
--
|
|
|
|
"It doesn't matter how complex the circumstances around you are. When you build your own temple of ideas, you start from the first stone. This code is your first stone." — Stoic reference from Kankys
|
|
|
|
---
|
|
<div id="czech-version"></div>
|
|
|
|
# 🇨🇿 PROJEKT DOXA Notes
|
|
|
|
#### Technický a architektonický manifest minimalistické poznámkové aplikace
|
|
|
|
**Záměr projektu:** Vytvořit absolutně nezávislé, bezpečné a minimalistické prostředí pro uchovávání lidských
|
|
myšlenek, poznámek a životních reflexí. V souladu se liberálními principy soběstačnosti aplikace nespoléhá na
|
|
cloudové databáze třetích stran, nýbrž operuje plně lokálně s otevřeným formátem JSON na vlastním serverovém
|
|
zázemí.
|
|
|
|
## 1. TECHNICKÁ ARCHITEKTURA
|
|
Pro zachování maximální rychlosti, čistoty kódu a nulových externích závislostí bude aplikace postavena na čistém
|
|
webovém standardu (tzv. Vanilla stack):
|
|
|
|
Frontend: Sémantické HTML5 pro strukturu, CSS3 pro minimalistické rozhraní, které nezatěžuje mysl
|
|
barevným chaosem.
|
|
|
|
Klientská logika: Čistý JavaScript (ES6+) bez frameworků (React/Vue). Vše běží nativně v prohlížeči.
|
|
|
|
Datová vrstva: Standardizovaný formát JSON. Poznámky jsou strukturovány jako pole objektů, kde každá
|
|
položka má jednoznačný identifikátor, časové razítko a textový obsah.
|
|
|
|
Desktop aplikace pro Linux a Windows jsou zabaleny do instalátorů AppImage - Linux a exe (Windows).
|
|
|
|
## 2. STRUKTURA DATOVÉHO FORMÁTU (JSON)
|
|
Čistota dat zaručuje, že tvé myšlenky budou čitelné i za dvacet let na jakémkoli zařízení. Základní schéma jedné
|
|
poznámky vypadá následovně:
|
|
|
|
```json
|
|
{
|
|
"notes": [
|
|
{
|
|
"id": "1719147600000",
|
|
"title": "Ranní reflexe",
|
|
"content": "Dnes odepřena digitální iluze. Mysl je klidná a pevná.",
|
|
"created_at": "2026-06-23T08:00:00Z",
|
|
"updated_at": "2026-06-23T08:00:00Z"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
## 3. STRATEGIE NASAZENÍ NA VPS (DOXA.LUKAN.CZ)
|
|
Jelikož aplikace (webová verze) bude běží na vlastní virtuální privátní síti (VPS) s architekturou:
|
|
|
|
### **Architektura (Čistě klientská)**
|
|
|
|
**Technické řešení ukládání dat** - Aplikace běží na subdoméně, ale data se ukládají v prohlížeči (LocalStorage / IndexedDB) s možností manuálního exportu/importu JSON souboru.
|
|
|
|
**Bezpečnostní aspekt** - Absolutní bezpečnost. Žádná data neodcházejí z tvého prohlížeči na síť.
|
|
|
|
|
|
## Licence
|
|
|
|
Aplikace je open-source a licencována pod MIT licencí.
|
|
|
|
--
|
|
|
|
"Nezáleží na tom, jak složité jsou okolnosti kolem tebe. Když stavíš vlastní chrám myšlenek, začínáš od prvního kamene. Tento kód je tvým prvním kamenem." — Stoický odkaz od Kankyse |