{"id":24956159,"url":"https://github.com/oslabs-beta/guardql","last_synced_at":"2025-07-08T00:39:11.323Z","repository":{"id":272350932,"uuid":"916265718","full_name":"oslabs-beta/GuardQL","owner":"oslabs-beta","description":"Uncover, Analyze, and Optimize Your GraphQL Performance","archived":false,"fork":false,"pushed_at":"2025-02-18T16:31:58.000Z","size":7033,"stargazers_count":14,"open_issues_count":9,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-05-07T18:08:31.337Z","etag":null,"topics":["error-log","fullstack","graphql","performance-metrics","performance-monitoring","query","query-language"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/oslabs-beta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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,"zenodo":null},"funding":{"github":"open-source-labs","custom":["https://donorbox.org/donations-to-oslabs-inc"]}},"created_at":"2025-01-13T19:09:01.000Z","updated_at":"2025-04-04T16:09:33.000Z","dependencies_parsed_at":"2025-01-13T21:34:54.390Z","dependency_job_id":"f27e2cb2-9b8a-4201-b38d-4505949f8b1b","html_url":"https://github.com/oslabs-beta/GuardQL","commit_stats":null,"previous_names":["oslabs-beta/guardql"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/oslabs-beta/GuardQL","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FGuardQL","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FGuardQL/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FGuardQL/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FGuardQL/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oslabs-beta","download_url":"https://codeload.github.com/oslabs-beta/GuardQL/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oslabs-beta%2FGuardQL/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264169475,"owners_count":23567307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["error-log","fullstack","graphql","performance-metrics","performance-monitoring","query","query-language"],"created_at":"2025-02-03T06:27:44.846Z","updated_at":"2025-07-08T00:39:11.303Z","avatar_url":"https://github.com/oslabs-beta.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://imgur.com/iNek9oJ.png\" width=\"50%\" alt=\"GuardQL_Logo\"\u003e\n\u003c/p\u003e\n\n[![GuardQL Website](https://img.shields.io/badge/Offcial%20Website-none?style=plastic\u0026label=GuardQL\u0026labelColor=%238A1877\u0026color=%23E623C6)](https://guardql.com/)\n[![GuardQL Plugin](https://img.shields.io/badge/Plugin-none?style=plastic\u0026label=GuardQL\u0026labelColor=%238A1877\u0026color=%23E623C6)](https://www.npmjs.com/package/guardql-plugin?activeTab=readme)\n[![GitHub Stars](https://img.shields.io/github/stars/oslabs-beta/GuardQL?style=plastic\u0026labelColor=%231F1B2D\u0026color=%23F2F2F2)](https://github.com/oslabs-beta/GuardQL/stargazers)\n[![GitHub Watchers](https://img.shields.io/github/watchers/oslabs-beta/GuardQL?style=plastic\u0026labelColor=%231F1B2D\u0026color=%23F2F2F2)](https://github.com/oslabs-beta/GuardQL/watchers)\n[![GitHub Forks](https://img.shields.io/github/forks/oslabs-beta/GuardQL?style=plastic\u0026labelColor=%231F1B2D\u0026color=%23F2F2F2)](https://github.com/oslabs-beta/GuardQL/network/members)\n\n# GuardQL\n\n### Uncover, Analyze, and Optimize Your GraphQL Performance\n\nGuardQL is a debugging and performance monitoring tool that logs GraphQL API errors, tracks slow query execution times, and provides a central dashboard with search and filtering functionality for multiple projects.\n\n\u003c!-- To be inserted:\nscreenshots, more details about product, acknowledgements, instructions\n--\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n  - [Technologies](#technologies)\n  - [Introduction](#introduction)\n  - [Features](#features)\n  - [Initial Set-up and Installation](#initial-set-up-and-installation)\n  - [Contributions](#contributions)\n  - [GuardQL Team](#guardql-team)\n  - [Contact Us](#contact-us)\n  - [License](#license)\n  - [Acknowledgements](#acknowledgements)\n\n\u003c/details\u003e\n\n## Technologies\n\u003c!-- Backend --\u003e\n![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge\u0026logo=javascript\u0026logoColor=%23F7DF1E)\n![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n![Apollo-GraphQL](https://img.shields.io/badge/-ApolloGraphQL-311C87?style=for-the-badge\u0026logo=apollo-graphql)\n![GraphQL](https://img.shields.io/badge/-GraphQL-E10098?style=for-the-badge\u0026logo=graphql\u0026logoColor=white)\n![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge\u0026logo=postgresql\u0026logoColor=white)\n![Supabase](https://img.shields.io/badge/Supabase-3ECF8E?style=for-the-badge\u0026logo=supabase\u0026logoColor=white)\n![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge\u0026logo=express\u0026logoColor=%2361DAFB)\n![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge\u0026logo=node.js\u0026logoColor=white)\n![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge\u0026logo=npm\u0026logoColor=white) \u003c!-- Frontend --\u003e ![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge\u0026logo=html5\u0026logoColor=white)\n![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge\u0026logo=css3\u0026logoColor=white)\n![MUI](https://img.shields.io/badge/MUI-%230081CB.svg?style=for-the-badge\u0026logo=mui\u0026logoColor=white)\n![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge\u0026logo=react\u0026logoColor=%2361DAFB)\n![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge\u0026logo=react-router\u0026logoColor=white)\n![React Hook Form](https://img.shields.io/badge/React%20Hook%20Form-%23EC5990.svg?style=for-the-badge\u0026logo=reacthookform\u0026logoColor=white)\n![Webpack](https://img.shields.io/badge/webpack-%238DD6F9.svg?style=for-the-badge\u0026logo=webpack\u0026logoColor=black)\n\n## Introduction\n\nDebugging GraphQL APIs can be difficult, especially when trying to pinpoint errors in slow or inefficient queries. GuardQL streamlines this process by providing a comprehensive debugging and performance monitoring tool designed for pre-production environments. It seamlessly integrates into GraphQL APIs to provide insights and optimization tools.\n\n- ✅ Captures GraphQL API errors with detailed logs\n- ✅ Monitors query execution times to detect inefficiencies\n- ✅ Offers an intuitive dashboard for visualizing key performance metrics\n- ✅ Enables users to create and manage multiple projects with a dropdown selection\n\nWith GuardQL, developers gain visibility into their GraphQL queries, making it easier to diagnose issues and optimize performance.\n\n\n\n## Features\n\n#### 🚨 Real-time GraphQL Error Tracking \u0026 Debugging\n* Error Logging: Captures GraphQL API errors, complete with timestamps and detailed error messages.\n* Query \u0026 Mutation Context: Provides full visibility into which GraphQL query or mutation caused the error, along with stack trace details.\n\n#### 🎯 Performance Monitoring \u0026 Query Optimization\n* Slow Query Identification: Automatically flags GraphQL queries that take longer than a set threshold, helping pinpoint performance bottlenecks.\n* Comprehensive Query Performance Tracking: Logs execution times for all queries, not just slow ones, offering a complete overview of GraphQL performance.\n\n#### 📊 Intuitive \u0026 Insightful Dashboard\n* User-Friendly Interface: Built for fast debugging and troubleshooting with a clean, easy-to-navigate UI.\n\n#### 🚀 Seamless GraphQL Integration via NPM Plugin\n* Effortless Setup: A lightweight NPM package that integrates smoothly into any GraphQL project with minimal configuration.\n* Automated Logging: Instantly starts tracking errors and performance metrics without requiring additional setup.\n\n## Initial Set-up and Installation\n\n#### 1️⃣ Sign Up \u0026 Get Your API Key\n* Create an account to gain access to the GuardQL Dashboard.\n* Upon signup, you'll receive a unique API key, which is required for configuring the plugin.\n![signup](packages/dashboard/src/client/assets/signup.gif)\n\n#### 2️⃣ Create \u0026 Select a Project\n* Inside the dashboard, create a new project using the project dropdown.\n* Select your project to start tracking GraphQL request performance and error logs.\n![projects](packages/dashboard/src/client/assets/dashboard.gif)\n\n#### 3️⃣ Install the GuardQL NPM Package\n* Add GuardQL to your application by running:\n    `npm install guardql-plugin`\n\n#### 4️⃣ Configure the Plugin in Apollo Server\n* Integrate GuardQL into your Apollo Server setup by adding the plugin and providing:\n    * Your project name\n    * The API key from your dashboard\n    * Any query execution time thresholds for slow query detection\n    ```\n       import { ApolloServer } from '@apollo/server';\n       import { guardqlPlugin } from 'guardql-plugin';\n\n       const server = new ApolloServer({\n         typeDefs,\n         resolvers,\n         plugins: [\n           guardqlPlugin({\n             apiKey: 'your-api-key',\n             projectName: 'your-project-name',\n             slowQueryThreshold: 1000 // in milliseconds\n           })\n        ]\n    });\n    ```\n\n#### 5️⃣ Run Your Application\n* Start your server and begin making GraphQL requests as usual.\n\n#### 6️⃣ Monitor Your API in Real-Time\n* Access the GuardQL Dashboard to track:\n    * Query execution times\n    * GraphQL errors with stack traces\n    * Performance trends and slow query alerts\n\n## Contributions\n\nWe welcome contributions!\n\nIf you’d like to contribute:\n\n1. Fork this repository\n2. Create a feature branch\n    - `git checkout -b feature-branch-name`\n3. Commit your changes\n    - `git add .`\n    - `git commit -m \"Added new feature XYZ\"`\n4. Push to your branch\n    - `git push origin feature-branch-name`\n5. Create a pull request\n\n**For major changes, please open an issue first to discuss what you’d like to change.**\n\n## Contact Us\n[![Static Badge](https://img.shields.io/badge/GuardQL%20%7C%20LinkedIn-none?style=for-the-badge\u0026color=%230A66C2)\n](https://linkedin.com/company/guardql)\n\n### GuardQL Team\n\u003c!-- Nico Henry --\u003e\n![Static Badge](https://img.shields.io/badge/Henry%20%E2%86%92-none?style=flat-square\u0026logoColor=white\u0026logoSize=auto\u0026label=Nico\u0026labelColor=%23E623C6\u0026color=%238A1877) [![Static Badge](https://img.shields.io/badge/%40Nico21221-Dark%20Charcoal?style=flat-square\u0026logo=Github\u0026logoColor=white\u0026logoSize=auto\u0026color=%23333333)](https://github.com/Nico21221) [![LinkedIn](https://img.shields.io/badge/linkedin/in/nico_henry-%230077B5.svg?style=flat-square\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/in/nico-henry/)\n\u003c!-- Cindy Rodriguez-Llivipuma --\u003e\n![Static Badge](https://img.shields.io/badge/Rodriguez%20Llivipuma%20%E2%86%92-none?style=flat-square\u0026logoColor=white\u0026logoSize=auto\u0026label=Cindy\u0026labelColor=%23E623C6\u0026color=%238A1877) [![Static Badge](https://img.shields.io/badge/%40csrl23-none?style=flat-square\u0026logo=Github\u0026logoColor=white\u0026logoSize=auto\u0026color=%23333333)](https://github.com/csrl23) [![LinkedIn](https://img.shields.io/badge/linkedin/in/cindy_rod_lliv-%230077B5.svg?style=flat-square\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/in/cindy-rod-lliv/)\n\u003c!-- Sienna Shepherd --\u003e\n![Static Badge](https://img.shields.io/badge/Shepherd%20%E2%86%92-none?style=flat-square\u0026logoColor=white\u0026logoSize=auto\u0026label=Sienna\u0026labelColor=%23E623C6\u0026color=%238A1877) [![Static Badge](https://img.shields.io/badge/%40codecaptaincode-none?style=flat-square\u0026logo=Github\u0026logoColor=white\u0026logoSize=auto\u0026color=%23333333)](https://github.com/codecaptaincode) [![LinkedIn](https://img.shields.io/badge/linkedin/in/sienna_shepherd-%230077B5.svg?style=flat-square\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/in/sienna-shepherd/)\n\u003c!-- Sabrina Ira --\u003e\n![Static Badge](https://img.shields.io/badge/Ira%20%E2%86%92-none?style=flat-square\u0026logoColor=white\u0026logoSize=auto\u0026label=Sabrina\u0026labelColor=%23E623C6\u0026color=%238A1877) [![Static Badge](https://img.shields.io/badge/%40sabrinaira-none?style=flat-square\u0026logo=Github\u0026logoColor=white\u0026logoSize=auto\u0026color=%23333333)](https://github.com/sabrinaira) [![LinkedIn](https://img.shields.io/badge/linkedin/in/sabrina_ira-%230077B5.svg?style=flat-square\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/in/sabrinaira)\n\u003c!-- Mike Thurstlic --\u003e\n![Static Badge](https://img.shields.io/badge/Thurstlic%20%E2%86%92-none?style=flat-square\u0026logoColor=white\u0026logoSize=auto\u0026label=Mike\u0026labelColor=%23E623C6\u0026color=%238A1877) [![Static Badge](https://img.shields.io/badge/%40thurstlic7-none?style=flat-square\u0026logo=Github\u0026logoColor=white\u0026logoSize=auto\u0026color=%23333333)](https://github.com/thurstlic7) [![LinkedIn](https://img.shields.io/badge/linkedin/in/mike_thurstlic-%230077B5.svg?style=flat-square\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/in/mike-thurstlic-a2b8a82a4/)\n\n\n\u003c!-- - **Nico Henry** - [@Nico21221](https://github.com/Nico21221)\n- **Cindy Rodriguez-Llivipuma** - [@csrl23](https://github.com/csrl23)\n- **Sienna Shepherd** - [@codecaptaincode](https://github.com/codecaptaincode)\n- **Sabrina Ira** - [@sabrinaira](https://github.com/sabrinaira)\n- **Mike Thurstlic** - [@thurstlic7](https://github.com/thurstlic7) --\u003e\n\n\u003c!-- Alternative linkedin badge --\u003e\n\u003c!-- [![LinkedIn](https://img.shields.io/badge/LinkedIn-GuardQL-blue?style=flat\u0026logo=linkedin)](https://www.linkedin.com/company/guardql/) --\u003e\n\n## License\nDistributed under the [MIT](LICENSE.txt) License.\n\n## Acknowledgements\n\nWe would like to thank the following resources that helped make GuardQL possible:\n\n- **[Material-UI](https://mui.com/)** - Used for designing UI components\n- **[Canva](https://www.canva.com/)** - Used to help create logo\n\nSpecial thanks to the entire GuardQL team for their hard work and dedication into making GuardQL a reality! ✨\n\n#### Return to [top](#guardql)","funding_links":["https://github.com/sponsors/open-source-labs","https://donorbox.org/donations-to-oslabs-inc"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foslabs-beta%2Fguardql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foslabs-beta%2Fguardql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foslabs-beta%2Fguardql/lists"}