Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-11-14T17:57:09Z

Knaylor: /* Workflow Diagrams */

=Expertiza=

Expertiza is an open-source project built using Ruby on Rails. It provides a platform for instructors and students to manage, submit, and evaluate assignments and projects. Instructors can create, edit, and grade assignments, while students can collaborate in teams, submit their work, and review peers' submissions. Expertiza supports submission across various document types, including URLs and wiki pages.

=Project Description=

Refactor the GraphQL API endpoint for contribution metrics by
* replacing hard-coded variables with reusable constants</li>
* implementing and publishing GraphQL queries as Flask endpoints so that the queries can be sent to the GitHub GraphQL API using a URL.</li>

=Key Objectives=
API Endpoint Development:

* Integrate existing code with Flask to expose GraphQL queries as API endpoints.

Testing and Validation:

* Conduct thorough testing (unit tests and integration tests) to verify the correctness and reliability of the implemented endpoints.
* Validate API functionality across different scenarios to ensure robustness and reliability.

=Implementation=

Each query was refactored by replacing hard-coded variables with new constants defined in [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Constants | Constants]]

===/comments===

* user_commit_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User commit comments.png|1000px]]

* user_gist_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User gist comments.png|1000px]]

* user_issue_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User issue comments.png|1000px]]

* user_repository_discussion_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User repo discussion comments.png|1000px]]

===/contributions===

* user_gists [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User gists.png|1000px]]

* user_issues [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User issues.png|1000px]]

* user_pull_requests [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User pull requests.png|1000px]]

===/time_range_contributions===

* user_contributions_collection [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/e659abccfa53588579d8074c560545eb6bd962dd Git commit]

[[File:User contributions collections.png|1000px]]

=Constants=

Field constants, node constants, and argument constants were all added to the codebase for reusability. Many of the [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Flask_API_Endpoints | GraphQL queries]] reference these variables multiple times. [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/48db85397252e609707e7fa34166d34d47e74416 Github commit]

===Field Constants===

[[File:field constants.png|500px]]

===Node Constants===

[[File:node constants.png|500px]]

===Argument Constants===

[[File:argument constants.png|500px]]

=Design Pattern and Strategy=
Our main goal is to help present the user's activities on GitHub which includes comments, contributions, time range contributions and profiles.

'''Frontend GUI (React)''':
* Implement an interactive UI for the users to display the information related to GitHub activities.
* To build a clean and robust frontend design to make it visually appealing.

'''Backend (Flask)''':
* Integrate Flask API endpoints to fetch the data which includes user's comments, contributions, time range contributions and profiles on Github.
* Integrate and implement a GitHub token-based login feature to access the information.

'''Workflow''':
* The backend system will fetch the data of the user's GitHub activities.
* It will pass this information to frontend which is fetched by React.
* After fetching the details from the backend system, it will display it in the form of UI.

== Workflow Diagrams ==

===Phase 1:===
[[File:Before-workflow-2401.png|1000px]]

===Phase 2:===
[[File:After-workflow-2401.png|1000px]]

== Phase 1 vs Phase 2: Key Differences ==

=== Objective ===
; Phase 1
: Develop a backend service using Flask to interact with the GitHub GraphQL API.
; Phase 2
: Refactor the backend code to improve maintainability by using constants and develop a frontend using React.

=== Backend Queries ===
; Phase 1
: Use hard-coded strings for field names, node names, and arguments.
; Phase 2
: Replace hard-coded strings with reusable constants for fields, nodes, and arguments.

=== API Endpoints ===
; Phase 1
: Implement API endpoints for `/comments`, `/contributions`, `/profiles`, and `/time_range_contributions`.
; Phase 2
: Enhance endpoints with better code readability by using pre-defined constants.

=== Frontend ===
; Phase 1
: No frontend implementation.
; Phase 2
: Develop a React-based frontend that allows users to interact with the GitHub GraphQL API.

=== Bulk Querying ===
; Phase 1
: No support for bulk querying of usernames.
; Phase 2
: Implement a feature that allows users to upload a CSV containing GitHub usernames and retrieves their contribution metrics.

=== Testing ===
; Phase 1
: Perform unit and integration tests for Flask endpoints.
; Phase 2
: Expand tests to include the refactored backend and React frontend functionality.

=== Deliverables ===
; Phase 1
: Deliver a functional backend that can query the GitHub GraphQL API.
; Phase 2
: Deliver a refactored backend, React frontend, and CSV bulk query feature for GitHub metrics.

=Flask API Endpoints=

===/comments===
[[File:Comments api endpoint.png|750px]]

===/contributions===
[[File:Contributions.png|750px]]

===/profiles===
[[File:Profiles.png|750px]]

===/time_range_contributions===
[[File:time_range_contributions.png|750px]]

=Testing=

===/time range contributions===
[[File:Time range contributions test.png|750px]]

===/comments===
[[File:test_user_commit_comments.png|750px]]

[[File:test_user_gist_comments.png|750px]]

[[File:test_user_issue_comments.png|750px]]

=Team=

Mentor:

Jialin Cui

Team Members:

Anjan Jagadishbhai Diyora

Vighnesh Hegde

Kaylie Naylor

=Github Repository=

original: https://github.ncsu.edu/jcui9/GitHub_Miner

forked: https://github.ncsu.edu/vshegde2/GitHub_Miner

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-11-14T17:56:27Z

Knaylor: /* Workflow Diagrams */

=Expertiza=

Expertiza is an open-source project built using Ruby on Rails. It provides a platform for instructors and students to manage, submit, and evaluate assignments and projects. Instructors can create, edit, and grade assignments, while students can collaborate in teams, submit their work, and review peers' submissions. Expertiza supports submission across various document types, including URLs and wiki pages.

=Project Description=

Refactor the GraphQL API endpoint for contribution metrics by
* replacing hard-coded variables with reusable constants</li>
* implementing and publishing GraphQL queries as Flask endpoints so that the queries can be sent to the GitHub GraphQL API using a URL.</li>

=Key Objectives=
API Endpoint Development:

* Integrate existing code with Flask to expose GraphQL queries as API endpoints.

Testing and Validation:

* Conduct thorough testing (unit tests and integration tests) to verify the correctness and reliability of the implemented endpoints.
* Validate API functionality across different scenarios to ensure robustness and reliability.

=Implementation=

Each query was refactored by replacing hard-coded variables with new constants defined in [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Constants | Constants]]

===/comments===

* user_commit_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User commit comments.png|1000px]]

* user_gist_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User gist comments.png|1000px]]

* user_issue_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User issue comments.png|1000px]]

* user_repository_discussion_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User repo discussion comments.png|1000px]]

===/contributions===

* user_gists [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User gists.png|1000px]]

* user_issues [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User issues.png|1000px]]

* user_pull_requests [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User pull requests.png|1000px]]

===/time_range_contributions===

* user_contributions_collection [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/e659abccfa53588579d8074c560545eb6bd962dd Git commit]

[[File:User contributions collections.png|1000px]]

=Constants=

Field constants, node constants, and argument constants were all added to the codebase for reusability. Many of the [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Flask_API_Endpoints | GraphQL queries]] reference these variables multiple times. [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/48db85397252e609707e7fa34166d34d47e74416 Github commit]

===Field Constants===

[[File:field constants.png|500px]]

===Node Constants===

[[File:node constants.png|500px]]

===Argument Constants===

[[File:argument constants.png|500px]]

=Design Pattern and Strategy=
Our main goal is to help present the user's activities on GitHub which includes comments, contributions, time range contributions and profiles.

'''Frontend GUI (React)''':
* Implement an interactive UI for the users to display the information related to GitHub activities.
* To build a clean and robust frontend design to make it visually appealing.

'''Backend (Flask)''':
* Integrate Flask API endpoints to fetch the data which includes user's comments, contributions, time range contributions and profiles on Github.
* Integrate and implement a GitHub token-based login feature to access the information.

'''Workflow''':
* The backend system will fetch the data of the user's GitHub activities.
* It will pass this information to frontend which is fetched by React.
* After fetching the details from the backend system, it will display it in the form of UI.

== Workflow Diagrams ==

Phase 1:
[[File:Before-workflow-2401.png|1000px]]

Phase 2:
[[File:After-workflow-2401.png|1000px]]

== Phase 1 vs Phase 2: Key Differences ==

=== Objective ===
; Phase 1
: Develop a backend service using Flask to interact with the GitHub GraphQL API.
; Phase 2
: Refactor the backend code to improve maintainability by using constants and develop a frontend using React.

=== Backend Queries ===
; Phase 1
: Use hard-coded strings for field names, node names, and arguments.
; Phase 2
: Replace hard-coded strings with reusable constants for fields, nodes, and arguments.

=== API Endpoints ===
; Phase 1
: Implement API endpoints for `/comments`, `/contributions`, `/profiles`, and `/time_range_contributions`.
; Phase 2
: Enhance endpoints with better code readability by using pre-defined constants.

=== Frontend ===
; Phase 1
: No frontend implementation.
; Phase 2
: Develop a React-based frontend that allows users to interact with the GitHub GraphQL API.

=== Bulk Querying ===
; Phase 1
: No support for bulk querying of usernames.
; Phase 2
: Implement a feature that allows users to upload a CSV containing GitHub usernames and retrieves their contribution metrics.

=== Testing ===
; Phase 1
: Perform unit and integration tests for Flask endpoints.
; Phase 2
: Expand tests to include the refactored backend and React frontend functionality.

=== Deliverables ===
; Phase 1
: Deliver a functional backend that can query the GitHub GraphQL API.
; Phase 2
: Deliver a refactored backend, React frontend, and CSV bulk query feature for GitHub metrics.

=Flask API Endpoints=

===/comments===
[[File:Comments api endpoint.png|750px]]

===/contributions===
[[File:Contributions.png|750px]]

===/profiles===
[[File:Profiles.png|750px]]

===/time_range_contributions===
[[File:time_range_contributions.png|750px]]

=Testing=

===/time range contributions===
[[File:Time range contributions test.png|750px]]

===/comments===
[[File:test_user_commit_comments.png|750px]]

[[File:test_user_gist_comments.png|750px]]

[[File:test_user_issue_comments.png|750px]]

=Team=

Mentor:

Jialin Cui

Team Members:

Anjan Jagadishbhai Diyora

Vighnesh Hegde

Kaylie Naylor

=Github Repository=

original: https://github.ncsu.edu/jcui9/GitHub_Miner

forked: https://github.ncsu.edu/vshegde2/GitHub_Miner

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-11-14T17:56:12Z

Knaylor:

=Expertiza=

Expertiza is an open-source project built using Ruby on Rails. It provides a platform for instructors and students to manage, submit, and evaluate assignments and projects. Instructors can create, edit, and grade assignments, while students can collaborate in teams, submit their work, and review peers' submissions. Expertiza supports submission across various document types, including URLs and wiki pages.

=Project Description=

Refactor the GraphQL API endpoint for contribution metrics by
* replacing hard-coded variables with reusable constants</li>
* implementing and publishing GraphQL queries as Flask endpoints so that the queries can be sent to the GitHub GraphQL API using a URL.</li>

=Key Objectives=
API Endpoint Development:

* Integrate existing code with Flask to expose GraphQL queries as API endpoints.

Testing and Validation:

* Conduct thorough testing (unit tests and integration tests) to verify the correctness and reliability of the implemented endpoints.
* Validate API functionality across different scenarios to ensure robustness and reliability.

=Implementation=

Each query was refactored by replacing hard-coded variables with new constants defined in [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Constants | Constants]]

===/comments===

* user_commit_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User commit comments.png|1000px]]

* user_gist_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User gist comments.png|1000px]]

* user_issue_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User issue comments.png|1000px]]

* user_repository_discussion_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User repo discussion comments.png|1000px]]

===/contributions===

* user_gists [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User gists.png|1000px]]

* user_issues [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User issues.png|1000px]]

* user_pull_requests [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User pull requests.png|1000px]]

===/time_range_contributions===

* user_contributions_collection [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/e659abccfa53588579d8074c560545eb6bd962dd Git commit]

[[File:User contributions collections.png|1000px]]

=Constants=

Field constants, node constants, and argument constants were all added to the codebase for reusability. Many of the [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Flask_API_Endpoints | GraphQL queries]] reference these variables multiple times. [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/48db85397252e609707e7fa34166d34d47e74416 Github commit]

===Field Constants===

[[File:field constants.png|500px]]

===Node Constants===

[[File:node constants.png|500px]]

===Argument Constants===

[[File:argument constants.png|500px]]

=Design Pattern and Strategy=
Our main goal is to help present the user's activities on GitHub which includes comments, contributions, time range contributions and profiles.

'''Frontend GUI (React)''':
* Implement an interactive UI for the users to display the information related to GitHub activities.
* To build a clean and robust frontend design to make it visually appealing.

'''Backend (Flask)''':
* Integrate Flask API endpoints to fetch the data which includes user's comments, contributions, time range contributions and profiles on Github.
* Integrate and implement a GitHub token-based login feature to access the information.

'''Workflow''':
* The backend system will fetch the data of the user's GitHub activities.
* It will pass this information to frontend which is fetched by React.
* After fetching the details from the backend system, it will display it in the form of UI.

== Workflow Diagrams ==

Phase 1:
[[File:Before-workflow-2401.png|500px]]

Phase 2:
[[File:After-workflow-2401.png|500px]]

== Phase 1 vs Phase 2: Key Differences ==

=== Objective ===
; Phase 1
: Develop a backend service using Flask to interact with the GitHub GraphQL API.
; Phase 2
: Refactor the backend code to improve maintainability by using constants and develop a frontend using React.

=== Backend Queries ===
; Phase 1
: Use hard-coded strings for field names, node names, and arguments.
; Phase 2
: Replace hard-coded strings with reusable constants for fields, nodes, and arguments.

=== API Endpoints ===
; Phase 1
: Implement API endpoints for `/comments`, `/contributions`, `/profiles`, and `/time_range_contributions`.
; Phase 2
: Enhance endpoints with better code readability by using pre-defined constants.

=== Frontend ===
; Phase 1
: No frontend implementation.
; Phase 2
: Develop a React-based frontend that allows users to interact with the GitHub GraphQL API.

=== Bulk Querying ===
; Phase 1
: No support for bulk querying of usernames.
; Phase 2
: Implement a feature that allows users to upload a CSV containing GitHub usernames and retrieves their contribution metrics.

=== Testing ===
; Phase 1
: Perform unit and integration tests for Flask endpoints.
; Phase 2
: Expand tests to include the refactored backend and React frontend functionality.

=== Deliverables ===
; Phase 1
: Deliver a functional backend that can query the GitHub GraphQL API.
; Phase 2
: Deliver a refactored backend, React frontend, and CSV bulk query feature for GitHub metrics.

=Flask API Endpoints=

===/comments===
[[File:Comments api endpoint.png|750px]]

===/contributions===
[[File:Contributions.png|750px]]

===/profiles===
[[File:Profiles.png|750px]]

===/time_range_contributions===
[[File:time_range_contributions.png|750px]]

=Testing=

===/time range contributions===
[[File:Time range contributions test.png|750px]]

===/comments===
[[File:test_user_commit_comments.png|750px]]

[[File:test_user_gist_comments.png|750px]]

[[File:test_user_issue_comments.png|750px]]

=Team=

Mentor:

Jialin Cui

Team Members:

Anjan Jagadishbhai Diyora

Vighnesh Hegde

Kaylie Naylor

=Github Repository=

original: https://github.ncsu.edu/jcui9/GitHub_Miner

forked: https://github.ncsu.edu/vshegde2/GitHub_Miner

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-11-14T17:55:08Z

Knaylor:

=Expertiza=

Expertiza is an open-source project built using Ruby on Rails. It provides a platform for instructors and students to manage, submit, and evaluate assignments and projects. Instructors can create, edit, and grade assignments, while students can collaborate in teams, submit their work, and review peers' submissions. Expertiza supports submission across various document types, including URLs and wiki pages.

=Project Description=

Refactor the GraphQL API endpoint for contribution metrics by
* replacing hard-coded variables with reusable constants</li>
* implementing and publishing GraphQL queries as Flask endpoints so that the queries can be sent to the GitHub GraphQL API using a URL.</li>

=Key Objectives=
API Endpoint Development:

* Integrate existing code with Flask to expose GraphQL queries as API endpoints.

Testing and Validation:

* Conduct thorough testing (unit tests and integration tests) to verify the correctness and reliability of the implemented endpoints.
* Validate API functionality across different scenarios to ensure robustness and reliability.

=Implementation=

Each query was refactored by replacing hard-coded variables with new constants defined in [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Constants | Constants]]

===/comments===

* user_commit_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User commit comments.png|1000px]]

* user_gist_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User gist comments.png|1000px]]

* user_issue_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User issue comments.png|1000px]]

* user_repository_discussion_comments [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/be08e09e3559367d2d27bdefaef946f166c2ee7d Git commit]

[[File:User repo discussion comments.png|1000px]]

===/contributions===

* user_gists [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User gists.png|1000px]]

* user_issues [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User issues.png|1000px]]

* user_pull_requests [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/890d7b2e8bc0656f8b76aac593b4e8702851a41a Git commit]

[[File:User pull requests.png|1000px]]

===/time_range_contributions===

* user_contributions_collection [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/e659abccfa53588579d8074c560545eb6bd962dd Git commit]

[[File:User contributions collections.png|1000px]]

=Constants=

Field constants, node constants, and argument constants were all added to the codebase for reusability. Many of the [[CSC/ECE_517_Fall_2024_-_G2401_Refactor_Graphql_API_endpoint_for_contribution_metrics#Flask_API_Endpoints | GraphQL queries]] reference these variables multiple times. [https://github.ncsu.edu/vshegde2/GitHub_Miner/commit/48db85397252e609707e7fa34166d34d47e74416 Github commit]

===Field Constants===

[[File:field constants.png|500px]]

===Node Constants===

[[File:node constants.png|500px]]

===Argument Constants===

[[File:argument constants.png|500px]]

=Design Pattern and Strategy=
Our main goal is to help present the user's activities on GitHub which includes comments, contributions, time range contributions and profiles.

'''Frontend GUI (React)''':
* Implement an interactive UI for the users to display the information related to GitHub activities.
* To build a clean and robust frontend design to make it visually appealing.

'''Backend (Flask)''':
* Integrate Flask API endpoints to fetch the data which includes user's comments, contributions, time range contributions and profiles on Github.
* Integrate and implement a GitHub token-based login feature to access the information.

'''Workflow''':
* The backend system will fetch the data of the user's GitHub activities.
* It will pass this information to frontend which is fetched by React.
* After fetching the details from the backend system, it will display it in the form of UI.

== Workflow Diagrams ==

Phase 1:
[[File:Before-workflow-2401.png|500px]

Phase 2:
[[File:After-workflow-2401.png|500px]
== Phase 1 vs Phase 2: Key Differences ==

=== Objective ===
; Phase 1
: Develop a backend service using Flask to interact with the GitHub GraphQL API.
; Phase 2
: Refactor the backend code to improve maintainability by using constants and develop a frontend using React.

=== Backend Queries ===
; Phase 1
: Use hard-coded strings for field names, node names, and arguments.
; Phase 2
: Replace hard-coded strings with reusable constants for fields, nodes, and arguments.

=== API Endpoints ===
; Phase 1
: Implement API endpoints for `/comments`, `/contributions`, `/profiles`, and `/time_range_contributions`.
; Phase 2
: Enhance endpoints with better code readability by using pre-defined constants.

=== Frontend ===
; Phase 1
: No frontend implementation.
; Phase 2
: Develop a React-based frontend that allows users to interact with the GitHub GraphQL API.

=== Bulk Querying ===
; Phase 1
: No support for bulk querying of usernames.
; Phase 2
: Implement a feature that allows users to upload a CSV containing GitHub usernames and retrieves their contribution metrics.

=== Testing ===
; Phase 1
: Perform unit and integration tests for Flask endpoints.
; Phase 2
: Expand tests to include the refactored backend and React frontend functionality.

=== Deliverables ===
; Phase 1
: Deliver a functional backend that can query the GitHub GraphQL API.
; Phase 2
: Deliver a refactored backend, React frontend, and CSV bulk query feature for GitHub metrics.

=Flask API Endpoints=

===/comments===
[[File:Comments api endpoint.png|750px]]

===/contributions===
[[File:Contributions.png|750px]]

===/profiles===
[[File:Profiles.png|750px]]

===/time_range_contributions===
[[File:time_range_contributions.png|750px]]

=Testing=

===/time range contributions===
[[File:Time range contributions test.png|750px]]

===/comments===
[[File:test_user_commit_comments.png|750px]]

[[File:test_user_gist_comments.png|750px]]

[[File:test_user_issue_comments.png|750px]]

=Team=

Mentor:

Jialin Cui

Team Members:

Anjan Jagadishbhai Diyora

Vighnesh Hegde

Kaylie Naylor

=Github Repository=

original: https://github.ncsu.edu/jcui9/GitHub_Miner

forked: https://github.ncsu.edu/vshegde2/GitHub_Miner

File:After-workflow-2401.png

2024-11-14T17:54:56Z

Knaylor:

File:Before-workflow-2401.png

2024-11-14T17:51:59Z

Knaylor:

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:49:59Z

Knaylor: /* /time_range_contributions */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:49:45Z

Knaylor: /* /time_range_contributions */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:49:37Z

Knaylor: /* Testing */

File:Time range contributions test.png

2024-10-30T02:48:46Z

Knaylor: G2401: testing results for time_range_contributions

== Summary ==
G2401: testing results for time_range_contributions

File:Time range contributions test.webp

2024-10-30T02:46:19Z

Knaylor: G2401: testing results for time_range_contributions

== Summary ==
G2401: testing results for time_range_contributions

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:41:20Z

Knaylor: /* Key Objectives */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:32:18Z

Knaylor: /* /time_range_contributions */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:31:23Z

Knaylor: /* /contributions */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:30:28Z

Knaylor: /* /comments */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:30:10Z

Knaylor: /* Implementation */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:28:38Z

Knaylor: /* Constants */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:27:34Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:26:47Z

Knaylor: /* /comments */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:26:38Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:26:06Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:23:52Z

Knaylor:

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:22:34Z

Knaylor: /* Constants */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:22:13Z

Knaylor: /* Implementation */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:22:00Z

Knaylor: /* Implementation */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:21:34Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:21:00Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:20:38Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:19:25Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:18:56Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:18:37Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:17:30Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:15:09Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:13:47Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:13:19Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:12:33Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:12:15Z

Knaylor: /* Flask API Endpoints */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T02:11:56Z

Knaylor: /* Flask API Endpoints */

File:Time range contributions.png

2024-10-30T02:04:06Z

Knaylor: G2401: api endpoint for time_range_contributions query

== Summary ==
G2401: api endpoint for time_range_contributions query

File:Profiles.png

2024-10-30T02:03:49Z

Knaylor: G2401: api endpoint for profiles query

== Summary ==
G2401: api endpoint for profiles query

File:Contributions.png

2024-10-30T02:03:33Z

Knaylor: G2401: api endpoint for contribution queries

== Summary ==
G2401: api endpoint for contribution queries

File:Comments api endpoint.png

2024-10-30T02:03:11Z

Knaylor: G2401: api endpoint for comments queries

== Summary ==
G2401: api endpoint for comments queries

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T01:58:08Z

Knaylor: /* Implementation */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T01:57:07Z

Knaylor: /* /comments */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T01:56:54Z

Knaylor: /* Implementation */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T01:56:13Z

Knaylor: /* Implementation */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T01:55:17Z

Knaylor: /* Implementation */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T01:54:31Z

Knaylor: /* Constants */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T01:54:16Z

Knaylor: /* Field Constants */

CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics

2024-10-30T01:54:07Z

Knaylor: /* Constants */