mirror of
https://codeberg.org/Kankys/doxa.git
synced 2026-11-11 06:44:36 +01:00
309 lines
12 KiB
Markdown
309 lines
12 KiB
Markdown
# DOXA
|
||
|
||
<p align="center">
|
||
<img src="https://img.shields.io/badge/license-MIT-blue?style=flat-square" alt="MIT license">
|
||
<img src="https://img.shields.io/badge/language-Go-00ADD8?style=flat-square&logo=go&logoColor=white" alt="Go">
|
||
<img src="https://img.shields.io/badge/language-JavaScript-F7DF1E?style=flat-square&logo=javascript&logoColor=black" alt="JavaScript">
|
||
<img src="https://img.shields.io/badge/platform-Linux%20%7C%20Windows%20%7C%20FreeBSD-6DA55F?style=flat-square" alt="Platforms">
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="#-doxa">English</a> |
|
||
<a href="#-doxa-cz">Čeština</a>
|
||
</p>
|
||
|
||
---
|
||
|
||
## 🌍 DOXA
|
||
|
||
**DOXA** is a collection of three minimalist, locally-focused applications for note management, message encryption, and command-line text processing. All projects share a common philosophy: **complete independence, privacy, and control over your data**. No cloud services, no tracking, no external dependencies. Your data belongs only to you.
|
||
|
||
---
|
||
|
||
## 📌 Projects in the DOXA Collection
|
||
|
||
### 1. 📝 [DOXA Notes](doxa-notes/)
|
||
|
||
**Web and desktop application for note management**
|
||
|
||
- **Description**: A minimalist note-taking application built on pure web standards (HTML5, CSS3, Vanilla JavaScript). Allows creating, editing, organizing, and exporting notes in an open JSON format.
|
||
- **Philosophy**: Local-first, no cloud databases, no tracking. Data is stored in the browser (LocalStorage/IndexedDB) or in local files.
|
||
- **Technologies**: Vanilla JavaScript (ES6+), HTML5, CSS3, JSON.
|
||
- **Platforms**: Web (browser), Linux (AppImage).
|
||
- **Features**:
|
||
- Tag support for note organization.
|
||
- Auto-save and manual JSON export/import.
|
||
- Dark/light mode and system settings.
|
||
- Drag & drop for reordering notes.
|
||
|
||
📖 [Read detailed documentation](doxa-notes/README.md)
|
||
|
||
---
|
||
|
||
### 2. 💻 [DOXA CLI](doxa-cli/)
|
||
|
||
**Command-line application for note management**
|
||
|
||
- **Description**: A command-line interface (CLI) version of DOXA Notes. Written in Go, it offers a modern Terminal User Interface (TUI) for managing notes directly from the terminal.
|
||
- **Philosophy**: Same philosophy as DOXA Notes – fully local, no external dependencies, data in JSON format.
|
||
- **Technologies**: Go (Golang), Bubble Tea (TUI framework).
|
||
- **Platforms**: Linux, FreeBSD.
|
||
- **Features**:
|
||
- Add, view, edit, delete, and search notes.
|
||
- Export and import notes in JSON format.
|
||
- Full compatibility with DOXA Notes (shared JSON format).
|
||
- Tag and filter support.
|
||
|
||
📖 [Read detailed documentation](doxa-cli/README.md)
|
||
|
||
---
|
||
|
||
### 3. 🔐 [DOXA Secret](doxa-secret/)
|
||
|
||
**Tool for encrypting and protecting secret messages**
|
||
|
||
- **Description**: A minimalist tool for encrypting text messages using custom alphabets defined in JSON. Each character is converted into a unique 5-character code.
|
||
- **Philosophy**: Local encryption, no data sent to servers. Your secrets remain only on your device.
|
||
- **Technologies**: Go (Golang), Bubble Tea (TUI framework).
|
||
- **Platforms**: Linux, FreeBSD.
|
||
- **Features**:
|
||
- Custom encryption alphabets (JSON format).
|
||
- Support for multiple ciphers and switching between them.
|
||
- Automatic diacritic normalization (basic Latin only).
|
||
- Import and export of encrypted messages (TXT format).
|
||
- Bilingual interface (Czech/English).
|
||
|
||
⚠️ **Important**: The application works only with basic Latin characters (no diacritics). Czech diacritics are automatically normalized (e.g., "ž" → "z", "á" → "a").
|
||
|
||
📖 [Read detailed documentation](doxa-secret/README.md)
|
||
|
||
---
|
||
|
||
### 4. ✅ [DOXA TODO](doxa-todo/)
|
||
|
||
**Terminal-based todo manager for task organization**
|
||
|
||
- **Description**: A minimalist terminal application for managing your tasks with support for categories, priorities, and tags. Built with Go and Bubble Tea TUI framework.
|
||
- **Philosophy**: Local-first task management. Your todos are stored locally in JSON format, giving you complete control over your data.
|
||
- **Technologies**: Go (Golang), Bubble Tea (TUI framework), Lip Gloss (styling).
|
||
- **Platforms**: Linux, FreeBSD.
|
||
- **Features**:
|
||
- Dual language support (Czech/English) with `l` key toggle.
|
||
- Two categories: Personal (🏠) and Work (💼).
|
||
- Three priority levels: Low (🟢), Medium (🟠), High (🔴).
|
||
- Tag support for task organization.
|
||
- Automatic timestamp for creation and modification.
|
||
- Search and filter by text, tags, or category.
|
||
- Export individual todos to text files.
|
||
- Data stored in `~/.doxa-todo/doxa_todo.json`.
|
||
|
||
📖 [Read detailed documentation](doxa-todo/README.md)
|
||
|
||
---
|
||
|
||
## 🔗 Common Features of All DOXA Projects
|
||
|
||
| Feature | DOXA Notes | DOXA CLI | DOXA Secret | DOXA TODO |
|
||
|---------|------------|----------|--------------|-----------|
|
||
| **Local Data Storage** | ✅ | ✅ | ✅ | ✅ |
|
||
| **Open Format (JSON)** | ✅ | ✅ | ✅ | ✅ |
|
||
| **No Cloud Dependencies** | ✅ | ✅ | ✅ | ✅ |
|
||
| **Open Source (MIT)** | ✅ | ✅ | ✅ | ✅ |
|
||
| **Minimalist Design** | ✅ | ✅ | ✅ | ✅ |
|
||
| **Tag Support** | ✅ | ✅ | ❌ | ✅ |
|
||
| **Search and Filtering** | ✅ | ✅ | ❌ | ✅ |
|
||
| **Encryption** | ❌ | ❌ | ✅ | ❌ |
|
||
| **Priority Levels** | ❌ | ❌ | ❌ | ✅ |
|
||
| **Categories** | ❌ | ❌ | ❌ | ✅ |
|
||
|
||
---
|
||
|
||
## 🛠 Installation
|
||
|
||
Each project has its own installation process. Detailed guides can be found in the respective README files:
|
||
|
||
- [DOXA Notes – Installation](doxa-notes/03_install.md)
|
||
- [DOXA CLI – Installation](doxa-cli/README.md#installation)
|
||
- [DOXA Secret – Installation](doxa-secret/README_EN.md#installation)
|
||
- [DOXA TODO – Installation](doxa-todo/README.md#installation)
|
||
|
||
---
|
||
|
||
## 📜 License
|
||
|
||
All projects in the DOXA collection are **open-source** and licensed under the **MIT License**. See the `LICENSE` files in each project for details.
|
||
|
||
---
|
||
|
||
## 💡 DOXA Philosophy
|
||
|
||
> "No 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
|
||
|
||
DOXA believes in:
|
||
- **Digital Sovereignty**: Your data belongs to you.
|
||
- **Minimalism**: Less is more. Clean code, clear mind.
|
||
- **Local-First**: No cloud dependencies, no tracking.
|
||
- **Openness**: Open code, open data, open mind.
|
||
|
||
---
|
||
|
||
## 📞 Contact and Support
|
||
|
||
- **Author**: Kankys
|
||
- **Repositories**:
|
||
- [DOXA on Codeberg](https://codeberg.org/Kankys/doxa)
|
||
|
||
|
||
---
|
||
|
||
---
|
||
|
||
# 🇨🇿 DOXA (CZ)
|
||
|
||
<p align="center">
|
||
<a href="#-doxa">English</a> |
|
||
<a href="#-doxa-cz">Čeština</a>
|
||
</p>
|
||
|
||
---
|
||
|
||
## 🌍 DOXA
|
||
|
||
**DOXA** je sbírka tří minimalistických, lokálně orientovaných aplikací pro správu poznámek, šifrování zpráv a práci s textem z příkazové řádky. Všechny projekty sdílejí společnou filozofii: **úplná nezávislost, soukromí a kontrola nad vašimi daty**. Žádné cloudové služby, žádné sledování, žádné externí závislosti. Vaše data patří pouze vám.
|
||
|
||
---
|
||
|
||
## 📌 Projekty v kolekci DOXA
|
||
|
||
### 1. 📝 [DOXA Notes](doxa-notes/)
|
||
|
||
**Webová a desktopová aplikace pro správu poznámek**
|
||
|
||
- **Popis**: Minimalistická poznámková aplikace postavená na čistých webových standardech (HTML5, CSS3, Vanilla JavaScript). Umožňuje vytvářet, upravovat, organizovat a exportovat poznámky v otevřeném JSON formátu.
|
||
- **Filozofie**: Local-first, žádné cloudové databáze, žádné sledování. Data se ukládají v prohlížeči (LocalStorage/IndexedDB) nebo v lokálních souborech.
|
||
- **Technologie**: Vanilla JavaScript (ES6+), HTML5, CSS3, JSON.
|
||
- **Platformy**: Web (prohlížeč), Linux (AppImage).
|
||
- **Vlastnosti**:
|
||
- Podpora tagů pro organizaci poznámek.
|
||
- Automatické ukládání (autosave) a manuální export/import JSON.
|
||
- Tmavý/světlý režim a systémové nastavení.
|
||
- Drag & drop pro přeskupování poznámek.
|
||
|
||
📖 [Přečtěte si podrobnější dokumentaci](doxa-notes/README.md)
|
||
|
||
---
|
||
|
||
### 2. 💻 [DOXA CLI](doxa-cli/)
|
||
|
||
**Terminálová aplikace pro správu poznámek**
|
||
|
||
- **Popis**: Příkazová řádka (CLI) verze DOXA Notes. Napsána v jazyce Go, nabízí moderní terminálové uživatelské rozhraní (TUI) pro správu poznámek přímo z terminálu.
|
||
- **Filozofie**: Stejná filozofie jako DOXA Notes – plně lokální, žádné externí závislosti, data v JSON formátu.
|
||
- **Technologie**: Go (Golang), Bubble Tea (TUI framework).
|
||
- **Platformy**: Linux, FreeBSD.
|
||
- **Vlastnosti**:
|
||
- Přidávání, prohlížení, úprava, mazání a vyhledávání poznámek.
|
||
- Export a import poznámek v JSON formátu.
|
||
- Plná kompatibilita s DOXA Notes (sdílený JSON formát).
|
||
- Podpora tagů a filtrování.
|
||
|
||
📖 [Přečtěte si podrobnější dokumentaci](doxa-cli/README_CZ.md)
|
||
|
||
---
|
||
|
||
### 3. 🔐 [DOXA Secret](doxa-secret/)
|
||
|
||
**Nástroj pro šifrování a ochranu tajných zpráv**
|
||
|
||
- **Popis**: Minimalistický nástroj pro šifrování textových zpráv pomocí vlastních abeced definovaných v JSON. Každý znak je převeden na unikátní 5znakový kód.
|
||
- **Filozofie**: Lokální šifrování, žádné odesílání dat na servery. Vaše tajemství zůstávají pouze na vašem zařízení.
|
||
- **Technologie**: Go (Golang), Bubble Tea (TUI framework).
|
||
- **Platformy**: Linux, FreeBSD.
|
||
- **Vlastnosti**:
|
||
- Vlastní šifrovací abecedy (JSON formát).
|
||
- Podpora více šifer a přepínání mezi nimi.
|
||
- Automatická normalizace diakritiky (pouze základní latinka).
|
||
- Import a export šifrovaných zpráv (TXT formát).
|
||
- Dvoujazyčné rozhraní (česky/anglicky).
|
||
|
||
⚠️ **Důležité**: Aplikace pracuje pouze se znaky základní latinky (bez diakritiky). Česká diakritika je automaticky normalizována (např. "ž" → "z", "á" → "a").
|
||
|
||
📖 [Přečtěte si podrobnější dokumentaci](doxa-secret/README.md)
|
||
|
||
---
|
||
|
||
### 4. ✅ [DOXA TODO](doxa-todo/)
|
||
|
||
**Terminálová aplikace pro správu úkolů**
|
||
|
||
- **Popis**: Minimalistická terminálová aplikace pro organizaci úkolů s podporou kategorií, priorit a štítků. Postavená na Go a Bubble Tea TUI frameworku.
|
||
- **Filozofie**: Lokální správa úkolů. Vaše úkoly jsou uloženy lokálně v JSON formátu, což vám dává úplnou kontrolu nad vašimi daty.
|
||
- **Technologie**: Go (Golang), Bubble Tea (TUI framework), Lip Gloss (stylování).
|
||
- **Platformy**: Linux, FreeBSD.
|
||
- **Vlastnosti**:
|
||
- Dvoujazyčná podpora (česky/anglicky) s přepínáním klávesou `l`.
|
||
- Dvě kategorie: Osobní (🏠) a Pracovní (💼).
|
||
- Tři úrovně priority: Nízká (🟢), Střední (🟠), Vysoká (🔴).
|
||
- Podpora štítků pro organizaci úkolů.
|
||
- Automatické časové razítko pro vytvoření a úpravu.
|
||
- Vyhledávání a filtrace podle textu, štítků nebo kategorie.
|
||
- Export jednotlivých úkolů do textových souborů.
|
||
- Data uložena v `~/.doxa-todo/doxa_todo.json`.
|
||
|
||
📖 [Přečtěte si podrobnější dokumentaci](doxa-todo/README_CZ.md)
|
||
|
||
---
|
||
|
||
## 🔗 Společné vlastnosti všech projektů DOXA
|
||
|
||
| Vlastnost | DOXA Notes | DOXA CLI | DOXA Secret | DOXA TODO |
|
||
|-----------|------------|----------|--------------|-----------|
|
||
| **Lokální uložení dat** | ✅ | ✅ | ✅ | ✅ |
|
||
| **Otevřený formát (JSON)** | ✅ | ✅ | ✅ | ✅ |
|
||
| **Žádné cloudové závislosti** | ✅ | ✅ | ✅ | ✅ |
|
||
| **Open Source (MIT)** | ✅ | ✅ | ✅ | ✅ |
|
||
| **Minimalistický design** | ✅ | ✅ | ✅ | ✅ |
|
||
| **Podpora tagů** | ✅ | ✅ | ❌ | ✅ |
|
||
| **Vyhledávání a filtrování** | ✅ | ✅ | ❌ | ✅ |
|
||
| **Šifrování** | ❌ | ❌ | ✅ | ❌ |
|
||
| **Úrovně priority** | ❌ | ❌ | ❌ | ✅ |
|
||
| **Kategorie** | ❌ | ❌ | ❌ | ✅ |
|
||
|
||
---
|
||
|
||
## 🛠 Instalace
|
||
|
||
Každý projekt má vlastní instalační postup. Podrobné návody naleznete v příslušných README souborech:
|
||
|
||
- [DOXA Notes – Instalace](doxa-notes/03_install.md)
|
||
- [DOXA CLI – Instalace](doxa-cli/README_CZ.md#instalace)
|
||
- [DOXA Secret – Instalace](doxa-secret/README.md#instalace)
|
||
- [DOXA TODO – Instalace](doxa-todo/README_CZ.md#instalace)
|
||
|
||
---
|
||
|
||
## 📜 Licence
|
||
|
||
Všechny projekty v kolekci DOXA jsou **open-source** a licencovány pod **MIT licencí**. Podrobnosti naleznete v souborech `LICENSE` v jednotlivých projektech.
|
||
|
||
---
|
||
|
||
## 💡 Filozofie DOXA
|
||
|
||
> "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
|
||
|
||
DOXA věří v:
|
||
- **Digitální suverenitu**: Vaše data patří vám.
|
||
- **Minimalismus**: Méně je více. Čistý kód, čistá mysl.
|
||
- **Lokální první**: Žádné cloudové závislosti, žádné sledování.
|
||
- **Otevřenost**: Otevřený kód, otevřená data, otevřená mysl.
|
||
|
||
---
|
||
|
||
## 📞 Kontakt a podpora
|
||
|
||
- **Autor**: Kankys
|
||
- **Repozitáře**:
|
||
- [DOXA na Codeberg](https://codeberg.org/Kankys/doxa) |