oslabs-beta / GraphPulse

Monitor GraphQL API performance.

GraphPulse

A tool to monitor GraphQL performance
Explore the code & contribute here

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
3. Open issues
4. Contributing
5. Authors
6. License

About The Project

GraphPulse is a application designed to tackle the challenges associated with GraphQL by offering a robust solution for monitoring performance metrics. This product aims to empower developers to optimize queries and enhance the overall performance of their GraphQL APIs.

(back to top)

Getting Started

Getting started with GraphPulse is a straightforward process. Users have two options: they can either use GraphPulse with a guest account or register for a personalized experience. Upon authentication, whether through a guest account or a registered one, users can begin running their GraphQL queries.

The visualization feature can be accessed through the user-friendly interface, providing a clear overview of the query structure. This visual representation aids developers in identifying patterns, dependencies, and potential areas for improvement.

Features

• Visualization of the GraphQL query tree using React Flow.
• Comprehensive table that includes essential information such as the date of the query, the specific endpoint targeted, latency, and query depth after running a query.

Open issues

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

GraphPulse is an open-source project, and contributions from the community are welcomed. If you're interested in contributing to GraphPulse, fork the repository, open an issue describing your contribution (open an issue with the tag "enhancement"), and submit a pull request. Your contributions will be reviewed and merged to benefit the entire community. Don't forget to give the project a star ⭐️ !

1. Fork the repository
2. Create your Feature Branch (git checkout -b feature/yourFeature)
3. Commit your Changes (git commit -m 'Add yourFeature')
4. Push to the Branch (git push origin feature/yourFeature)
5. Open a Pull Request

(back to top)

Authors

• Jerel Cruz Github | LinkedIn
• Binetou Maggio Github |LinkedIn
• Daniel Song - Github | LinkedIn
• David Tskhvedadze - Github | LinkedIn

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)