ECE461_Team_Phase_2

Overview

This project evaluates npm modules and GitHub repositories by calculating various metric scores to assist developers in selecting reliable open-source modules.

Team Members

• Anish Sudini
• Leyton Bostre
• Adam Kahl
• Blake Neely

Setup Instructions

1. Set Environment Variables:

   export GITHUB_TOKEN=your_github_token_here
   export LOG_FILE=your_log_file_path_here
   export LOG_LEVEL=your_log_level_here

2. Clone the Repository:

   git clone https://github.com/lbostre/ECE461_Team_Phase_2
   cd ECE461_Team_Phase_2

3. Install Dependencies:

   ./run install
   

Usage

1. Run Individual Tests:

   ./run <file_name>.txt

2. Run the Test Suite:

   ./run test
   

Metrics Used to Calculate NetScore

1. Bus Factor: Measures the number of contributors to assess the risk associated with project maintenance.
2. Ramp Up Time: Evaluates the ease of understanding and integrating the project.
3. Correctness: Assesses the presence and quality of test suites to ensure code reliability.
4. Responsive Maintainer: Analyzes the responsiveness of maintainers by examining issue and pull request activity.
5. License: Checks for compatibility with the GNU LGPLv2.1 license. Each metric is calculated using specific criteria and contributes to the overall NetScore, aiding in the evaluation of open-source modules.

Repository Structure

1. github/workflows/: Contains GitHub Actions workflows.
2. src/: Source code files.
3. gitignore: Specifies files to be ignored by Git.
4. README.md: Project documentation.
5. eslint.config.js: ESLint configuration.
6. index.ts: Main entry point.
7. package-lock.json: Dependency tree.
8. package.json: Project metadata and dependencies.
9. run: Execution script.
10. run.bat: Windows batch execution script.
11. test_cases.txt: Test cases for evaluation.
12. tsconfig.json: TypeScript configuration.
13. types.ts: Type definitions.

License

This project is licensed under the GNU LGPLv2.1 License.

Acknowledgements

Special thanks to the ECE461 course instructor and teaching assistants for their guidance and support.