ipfs/ipfs-companion

Detect IPFS Desktop and Provide Additional Node Controls

Open

#350 opened on Jan 4, 2018

View on GitHub
 (0 comments) (2 reactions) (1 assignee)JavaScript (364 forks)batch import
P2effort/weeksexp/intermediatehelp wantedkind/enhancementneed/analysisstatus/readytopic/design-ux

Repository metrics

Stars
 (1,992 stars)
PR merge metrics
 (Avg merge 53d 3h) (1 merged PR in 30d)

Description

Some of user journeys introduce presence of IPFS Desktop (previously known as Station). It is a standalone Electron app that can do a lot more than we can do in WebExtension.

WebExtensions provide Native messaging API, which may be used for communication with external executable installed on user's system.

TL;DR

The idea is to detect presence of IPFS Desktop and provide user with additional controls.

MVP: show controls for starting/stopping go-ipfs daemon

Tasks

  • Research if APIs in Chrome and Firefox are close enough that we can maintain single codebase 🤞
  • Add necessary files to IPFS Desktop installer
  • Add native messaging support to Companion
  • Add controls for starting / stopping daemon installed with IPFS Desktop (aka "Ability to Launch IPFS" )
  • Documentation explaining how to add other hooks/controls over Native messaging bridge

References

Contributor guide

Research direction
Investigate the native messaging API in Chrome and Firefox, and explore how to detect IPFS Desktop installation.
Tech stack
javascript
Domain
frontendbackend
Issue type
Feature
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.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptBrowser Extension
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30