vercel/hyper

Document Hyper architecture

Open

#817 opened on Oct 7, 2016

View on GitHub
 (0 comments) (11 reactions) (0 assignees)TypeScript (44,582 stars) (3,558 forks)batch import
help wanted🎨 Type: Enhancement💛 Priority: Medium

Description

I think we should document the overall architecture to help new contributors get up to speed! I still don't have a grasp on the architecture. :worried: I'd be great to have some block diagrams and flow charts showing how the following are related and connected: hterm, electron, redux, ui presentation, etc.

Contributor guide

Tech stack
typescriptelectronreact
Domain
documentationdesktop
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of HyperFamiliarity with Electron appsUnderstanding of React and Redux
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the Hyper source code to identify the key components: hterm (the terminal emulator), Electron main process, Redux store, and UI presentation layer. Look at the file structure to understand how they communicate. Then create block diagrams illustrating their relationships and data flow. Also review any existing documentation or comments in code to ensure accuracy.