derhuerst/dict-cc-cli

use protocol buffers to get a smaller data file

Open

#4 opened on Mar 8, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1 fork)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (12 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

For de -> en, the generated data file is currently 65m in size. We can easily reduce this without sacrificing a lot of speed by using protocol buffers.

  • write a .proto file
  • using pbf, generate en-/decoding code
  • generate a binary data file
  • read from the file

Contributor guide

Research direction
Familiarize yourself with Protocol Buffers and the pbf library. Look at the existing data generation code in the repository to understand how the current data file is built. Then design a .proto file matching the data structure, generate encoding/decoding code using pbf, and modify the data generation and reading scripts accordingly.
Tech stack
javascript
Domain
backend
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.
Half day
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
GitNode.jsnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60