A CLI for trustworthy module re-use

ECE461 Project: Team 17

Project Description: Phase 1

This project involved building a command-line interface (CLI) to help evaluate the trustworthiness of open-source JavaScript modules for reuse. The CLI takes in a list of module URLs as input, evaluates various metrics related to module quality and maintainer responsiveness, and outputs an overall trustworthiness score along with subscores for each metric

The project was completed in 5 phases over 5 weeks:
Week 1: Planning and Design
Weeks 2-4: Implementation, Validation, Delivery
Week 5: Postmortem

Getting Started

• Step 1: Run chmod +x run command
  The command "chmod +x run" is used to make the file "run" executable in Unix-like operating systems, including Linux and macOS.

• Step 2: Run ./run install command
  It install all the dependencies required to run the program on ECE server

• Step 3: Run ./run URL_FILE command
  It runs the "URL_FILE" of the program that has ASCII-coded values for URL that we are required to work on for calculating the metrics.

• Step 4: Run ./run test command
  It runs the test cases that cover 80% of our code

Implementation Details

• Written in TypeScript
• Metrics calculated using data from GitHub API and local Git repository analysis
• Uses npm for command line argument parsing

Things to note

• API Limit
  Though this is not directly related to the I/O specification of the auto-grader, while we were doing our own testing we have been running into issues of exceeding the hourly request limit. This could cause the auto-grader to choke.

Project Description: Phase 2

AWS URL where our current website is hosted:

http://phase2-ece461.s3-website-us-east-1.amazonaws.com/http://phase2-ece461.s3-website-us-east-1.amazonaws.com/

Credits

This project was created as part of an assignment for ECE 461 at Purdue University. Team members:

• Christopher Colloquit
• Alan Fu
• Shreya Rathi
• Li Hong Wu