{"id":25293845,"url":"https://github.com/srujayreddy/subsgredient-app","last_synced_at":"2026-05-17T02:46:04.584Z","repository":{"id":273023988,"uuid":"918486478","full_name":"SrujayReddy/Subsgredient-App","owner":"SrujayReddy","description":"Java-based application that helps users find and substitute ingredients efficiently.","archived":false,"fork":false,"pushed_at":"2025-01-18T05:00:09.000Z","size":54,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-19T10:59:23.885Z","etag":null,"topics":["algorithm-optimization","csv-integration","data-structures","educational-project","full-stack","java","junit5","red-black-tree","team-collaboration"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SrujayReddy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-18T03:53:23.000Z","updated_at":"2025-07-09T16:48:53.000Z","dependencies_parsed_at":"2025-01-18T05:27:24.242Z","dependency_job_id":"0dfd2b11-5add-4633-a847-d871bf1753f9","html_url":"https://github.com/SrujayReddy/Subsgredient-App","commit_stats":null,"previous_names":["srujayreddy/subsgredient-app"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SrujayReddy/Subsgredient-App","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SrujayReddy%2FSubsgredient-App","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SrujayReddy%2FSubsgredient-App/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SrujayReddy%2FSubsgredient-App/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SrujayReddy%2FSubsgredient-App/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SrujayReddy","download_url":"https://codeload.github.com/SrujayReddy/Subsgredient-App/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SrujayReddy%2FSubsgredient-App/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33125739,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T18:38:32.183Z","status":"online","status_checked_at":"2026-05-17T02:00:05.366Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algorithm-optimization","csv-integration","data-structures","educational-project","full-stack","java","junit5","red-black-tree","team-collaboration"],"created_at":"2025-02-13T01:55:39.621Z","updated_at":"2026-05-17T02:46:04.549Z","avatar_url":"https://github.com/SrujayReddy.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Subsgredient\n\n**Subsgredient** is a Java-based application for discovering and substituting ingredients quickly and efficiently. It uses a Red-Black Tree (with multi-key nodes) for optimized data lookup and insertion, powered by a CSV dataset of 2,000+ ingredients.\n\n---\n\n## Table of Contents\n\n1. [Project Overview](#project-overview)  \n2. [Features](#features)  \n3. [Technologies \u0026 Tools](#technologies--tools)  \n4. [Setup \u0026 Installation](#setup--installation)  \n5. [Usage](#usage)  \n6. [Testing](#testing)  \n7. [Project Structure](#project-structure)  \n8. [Contributors](#contributors)  \n9. [License](#license)  \n\n---\n\n## Project Overview\n\nThis project allows users to:\n- Insert and store large numbers of ingredients.\n- Retrieve potential substitutions or related ingredient data.\n- Enjoy fast search times due to an underlying Red-Black Tree implementation.\n\nYou’ll find additional logs and the `out/` directory included in this repository for reference and demonstration.\n\n---\n\n## Features\n\n- **Ingredient Data Management**: Load ingredients from `ingredients.csv` and manage them in a Red-Black Tree.  \n- **Multiple Duplicates Handling**: Stores duplicates within a single node (using a KeyList structure).  \n- **Frontend \u0026 Backend Separation**: Clear distinction between the user interface (`FrontendDev`) and the core logic (`BackendImplementation`).  \n- **Extensive Testing**: Includes JUnit-based test suites for both frontend and backend functionalities.\n\n---\n\n## Technologies \u0026 Tools\n\n- **Java (11+)**  \n- **JUnit 5** for testing  \n- **Makefile** for builds and running tests  \n- **CSV** for ingredient datasets  \n- **Git** for version control  \n\n---\n\n## Setup \u0026 Installation\n\n1. **Clone the repository**:\n\n~~~~bash\ngit clone https://github.com/SrujayReddy/Subsgredient-App.git\ncd Subsgredient-App\n~~~~\n\n2. **Ensure Java 11+** is installed.  \n   If you plan to run tests locally, you may need the `junit5.jar` in your parent folder or configured in your IDE.\n\n3. **Review the files** to confirm presence of `.java` files, `Makefile`, `ingredients.csv`, etc.\n\n---\n\n## Usage\n\nYou can compile and run using the **Makefile** or standard `javac`/`java` commands.\n\n- **Compile \u0026 run the backend**:\n\n~~~~bash\nmake run\n~~~~\n\nThis compiles `BackendImplementation.java` and runs it.\n\nAlternatively, compile everything manually:\n\n~~~~bash\njavac *.java\njava BackendImplementation\n~~~~\n\n*(Adjust class name if you want to run the frontend instead.)*\n\n---\n\n## Testing\n\nWe have two main sets of tests: **`BackendDeveloperTests`** and **`FrontendTests`**.\n\n- **Backend Tests**:\n\n~~~~bash\nmake runBDTests\n~~~~\n\nCompiles and runs all JUnit 5 tests for the backend.\n\n- **Frontend Tests**:\n\n~~~~bash\nmake runFDTests\n~~~~\n\nCompiles and runs all JUnit 5 tests for the frontend.\n\n---\n\n## Project Structure\n\n```\nSubsgredient/\n├── backend/\n│   ├── BackendImplementation.java\n│   ├── BackendInterface.java\n│   ├── BinarySearchTree.java\n│   ├── RedBlackTree.java\n│   ├── SortedCollectionInterface.java\n│   ├── Ingredient.java\n│   ├── IngredientInterface.java\n│   ├── IngredientPlaceholder.java\n│   ├── IterableMultiKeyRBT.java\n│   ├── KeyList.java\n│   └── KeyListInterface.java\n├── frontend/\n│   ├── FrontendDev.java\n│   ├── FrontendInterface.java\n│   └── TextUITester.java\n├── tests/\n│   ├── BackendDeveloperTests.java\n│   └── FrontendTests.java\n├── data/\n│   └── ingredients.csv\n├── log\n├── out/\n├── Makefile\n├── .gitignore\n└── README.md\n```\n\n- **`out/`** and **`log`** are included for demonstration logs, class outputs, etc.\n\n---\n\n## Contributors\n\n- **Srujay Reddy Jakkidi** *(Backend)*\n- **Katie** *(Frontend)*\n\n---\n\n## License\n\nThis project was developed as part of the **CS 537: Introduction to Operating Systems** course at the University of Wisconsin–Madison. It is shared strictly for educational and learning purposes only.\n\n**Important Notes:**\n- Redistribution or reuse of this code for academic submissions is prohibited and may violate academic integrity policies.\n- The project is licensed under the [MIT License](https://opensource.org/licenses/MIT). Any usage outside academic purposes must include proper attribution.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrujayreddy%2Fsubsgredient-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsrujayreddy%2Fsubsgredient-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsrujayreddy%2Fsubsgredient-app/lists"}