CSC/ECE 517 Spring 2023 -G2335. Develop Frontend UI Interface for GraphQL Query: Difference between revisions
| Line 6: | Line 6: | ||
'''For this project, we are developing the front-end user interface for GraphQL query for a desktop application to display summary statistics of Github repository and Github users' contribution to said repository.''' Github provides [https://docs.github.com/en/graphql GraphQL API] for developers who are interested in the raw data surrounding each Github repository and user. Such data can be used to develop metrics to monitor a repository's activities, performance, community involvement, community usage, and contribution from the community and collaborators. The main focus of this project is developing a UI to display these metrics and summary statistics in graphical and tabular formats to provide clients with insights into their own Github repository or any Github repository they are interested in. | '''For this project, we are developing the front-end user interface for GraphQL query for a desktop application to display summary statistics of Github repository and Github users' contribution to said repository.''' Github provides [https://docs.github.com/en/graphql GraphQL API] for developers who are interested in the raw data surrounding each Github repository and user. Such data can be used to develop metrics to monitor a repository's activities, performance, community involvement, community usage, and contribution from the community and collaborators. The main focus of this project is developing a UI to display these metrics and summary statistics in graphical and tabular formats to provide clients with insights into their own Github repository or any Github repository they are interested in. | ||
Our interface design will be developed from scratch based on client requirements (# | Our interface design will be developed from scratch based on client requirements ([https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2023_-G2335._Develop_Frontend_UI_Interface_for_GraphQL_Query#Feature_Requirements project requirements]). We aim to make this design and interface a building block and sound foundation for future projects that want to extend our use case or build similar applications. | ||
== Feature Requirements == | == Feature Requirements == | ||
Revision as of 19:34, 5 April 2023
Topic Overview
Motivation
Numerical data are important in providing insights. However, in raw format, numerical data are hard to grasp and introduce more confusion than information. Graphical presentations of numerical data are needed to draw insights and focus from the available data.
For this project, we are developing the front-end user interface for GraphQL query for a desktop application to display summary statistics of Github repository and Github users' contribution to said repository. Github provides GraphQL API for developers who are interested in the raw data surrounding each Github repository and user. Such data can be used to develop metrics to monitor a repository's activities, performance, community involvement, community usage, and contribution from the community and collaborators. The main focus of this project is developing a UI to display these metrics and summary statistics in graphical and tabular formats to provide clients with insights into their own Github repository or any Github repository they are interested in.
Our interface design will be developed from scratch based on client requirements (project requirements). We aim to make this design and interface a building block and sound foundation for future projects that want to extend our use case or build similar applications.
Feature Requirements
Todo: list feature requirements of the UI
Interface Design
Todo: Include basic design for the UI
Implementation Details
Todo: Inlcude implementation details such as tool used (PyQt6, Python, Matplotlib, etc.), views, and UI components
Testing
Todo: include testing plans and tool here
Future Work
Todo: Include notes about future work and application of this UI
Contributors
- Aileen Jacob (amjacob2)
- Anh Nguyen (anguyen9)
- Joe Johnson (jdjohns4)
- Mentor Jialin Cui (jcui9)