HashSlap-Summer-of-Code/cipher-vault

Convert Vigenère Cipher to Node.js Module

Open

#10 opened on Jun 19, 2025

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)JavaScript (7 forks)auto 404
HSSOCIntermediateenhancementgood first issuehacktoberfest

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

Description:
Refactor the existing vigenere.js script to work as a reusable Node.js module that can be installed via npm and imported in other scripts. This makes the cipher logic modular and scalable.

Expected Tasks:

  • In js-ciphers/, create a proper Node.js module:
    • Export encrypt and decrypt functions
    • Use module.exports or export syntax
  • Add a package.json with name, version, description
  • Create a sample test.js to demonstrate how to use the module
  • Update the root README.md with:
    • Installation instructions
    • Example usage in Node.js

Stretch Tasks:

  • Publish it locally via npm link
  • Add a TypeScript version with types included

Contributor guide

Research direction
Examine the existing vigenere.js script, then refactor it to export encrypt and decrypt functions as a Node.js module. Create a package.json and a test.js to demonstrate usage. Update README with installation and usage instructions. Optionally, set up npm link and add TypeScript types.
Tech stack
javascriptnodejs
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
JavaScriptNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75