Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

DOCS & FAQ: Architecture

オープン
#38 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
30/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
java, javascript, nodejs, scala
領域
documentation

調査の方向性

このissueでは、ファイル、テスト、エントリーポイントが指定されていません。まず、リポジトリで説明されているコンポーネントと通信経路を洗い出します。これには、Hackpad、Etherpad、AppJet、ならびにfrontend/backend間のタスクリストのフローが含まれます。Wikiページが、列挙されたアーキテクチャ、拡張、アーキテクチャ上の意思決定に関する質問に回答していれば完了です。

索引モデルが issue の本文から書いたものです。

説明

First of all - thanks a lot for open sourcing Hackpad.

It would be nice if someone with deep insight would contribute architectural documentation of the Hackpad in the Wiki. Most of the questions I get when browsing the source are probably actually related to the AppJet engine, but the info is hard to find.

It would be nice if it answered following questions:

  • What components (libraries, technologies...) are involved and how they talk to each other?
  • How to extend the functionality? The in depth view how "task list" functionality comes together with all the FE and BE parts.
  • Architectural decisions:
    • Why is Hackpad built on top of Etherpad not for example Etherpad Lite? It might be as easy, as Etherpad Lite did not exists at the time. The problem with building on top of Etherpad which is on top of AppJet, which open source development seems to be discontinued and there are no resources available.
    • Is there any edge in using AppJet to plain (Node).JS solution like Etherpad Lite? From what I see AppJet is Java/Scala framework that runs the JavaScript code inside JVM using Rhino engine. Seems like a very fat stack. What are the benefits of the stack? More of a AppJet engine question, but the info is very hard to find.

If this should be discussed somewhere else, please let me know.

主要言語
Java
スター
3.6k
フォーク
519
PR マージ指標
30日以内にマージされた PR はありません

環境構築

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

dropbox/hackpad のほかの issue

dropbox/hackpad の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。