hackmdio/codimd

Feature request: Download your data

Open

#823 opened on May 15, 2018

View on GitHub
 (3 comments) (6 reactions) (0 assignees)JavaScript (8,949 stars) (1,038 forks)batch import
featurehelp wanted

Description

i'd like to see a 'download your data'-function in hackmd similar to google takeout.

reasons:

  • it's a nice thing to have

legal: offering hackmd-services to europeans comes with legal responsibilities (general data protection regulation GDPR)

  • offering users the possibility of backups and admins an export function ( right of access, Art. 15 GDPR)
  • possible data portability by uploading a backup to another hackmd-instance ( data portability, Art 20 GDPR)

Contributor guide

Tech stack
javascriptnodejs
Domain
full stack
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScriptNode.jsbasic file system operations
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Begin by understanding the current data model and storage mechanism in CodiMD. Review existing implementations in similar open source projects for inspiration. Identify the necessary backend changes to generate a downloadable archive (e.g., ZIP) of user notes and metadata. Design a simple UI button or page for initiating the download. Consider GDPR requirements for data portability.