-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add language and framework decision
- Loading branch information
Showing
2 changed files
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# ℹ️ Overview | ||
|
||
Following in the footsteps of [node-ui](https://github.com/algorand/node-ui), this project | ||
should be built as a first class TUI interface for Algorand daemons. | ||
|
||
## ✅ Decisions | ||
|
||
- **SHOULD** be built with [Charm](https://charm.sh/)/[Bubbletea](https://github.com/charmbracelet/bubbletea) and [Bubbles](https://github.com/charmbracelet/bubbles). | ||
- **SHOULD** conform to GoLang, Charm, and Bubbles practices of other TUI applications | ||
- **SHOULD** maintain high level of unit testing | ||
|
||
## 🔨 Deliverables | ||
|
||
- facilitate key registration | ||
- thin algod REST client | ||
- display status and health |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Decisions for this Project | ||
|
||
- [1. GoLang/Charm TUI](1-GoLang-Charm.md) |