Skip to content

Commit

Permalink
docs: add language and framework decision
Browse files Browse the repository at this point in the history
  • Loading branch information
PhearZero committed Sep 30, 2024
1 parent 76d7cd0 commit e660b62
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .decisions/1-GoLang-Charm.md
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
3 changes: 3 additions & 0 deletions .decisions/README.md
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)

0 comments on commit e660b62

Please sign in to comment.