console/README.md

76 lines
3.2 KiB
Markdown
Raw Normal View History

2022-05-18 07:26:57 +00:00
# GraphQL Hive
2022-05-25 12:22:09 +00:00
GraphQL Hive provides all the tools the get visibility of your GraphQL architecture at all stages, from standalone APIs to composed schemas (Federation, Stitching).
- Visit [graphql-hive.com](https://graphql-hive.com)
- [Read the announcement blog post](https://www.the-guild.dev/blog/announcing-graphql-hive-public)
- [Read the docs](https://docs.graphql-hive.com)
## Built for the community, for all GraphQL APIs
GraphQL Hive has been built with 3 main objectives in mind:
- **Help GraphQL developers to get to know their GraphQL APIs** a little more with our Schema Registry, Performance Monitoring, Alerts, and Integrations.
- **Support all kinds of GraphQL APIs**, from Federation, and Stitching, to standalone APIs.
- **Open Source at the heart**: 100% open-source and build in public with the community.
- **A plug and play SaaS solution**: to give access to Hive to most people with a generous free "Hobby plan"
## Features Overview
### Schema Registry
GraphQL Hive offers 3 useful features to manage your GraphQL API:
- **Prevent breaking changes** - GraphQL Hive will run a set of checks and notify your team via Slack, GitHub, or within the application.
- **Data-driven** definition of a “breaking change” based on Operations Monitoring.
- **History of changes** - an access to the full history of changes, even on a complex composed schema (Federation, Stitching).
- **High-availability and multi-zone CDN** service based on Cloudflare to access Schema Registry
### Monitoring
Once a Schema is deployed, **it is important to be aware of how it is used and what is the experience of its final users**.
## Self-hosted
GraphQL Hive is completely open-source under the MIT license, meaning that you are free to host on your own infrastructure.
GraphQL Hive helps you get a global overview of the usage of your GraphQL API with:
- Error rates and repartition
- Global and queries performances (latency, RPM…)
- Operations count
- Active GraphQL clients
### Integrations
GraphQL Hive is well integrated with **Slack** and most **CI/CD** systems to get you up and running as smoothly as possible!
GraphQL Hive can notify your team when schema changes occur, either via Slack or a custom webhook.
Also, the Hive CLI allows integration of the schema checks mechanism to all CI/CD systems (GitHub, BitBucket, Azure, and others). The same applies for schema publishing and operations checks.
If you are using GitHub, you can directly benefit from the **GraphQL Hive app that will automatically add status checks to your PRs**!
### Join us in building the future of GraphQL Hive
Like all [The Guild](https://the-guild.dev) projects, GraphQL Hive is built with the community.
We can't wait to get you onboard and get your feedback, pull requests, and feature requests.
See you in Hive! 🐝
2022-05-18 07:26:57 +00:00
## Project Stack
2022-05-25 12:22:09 +00:00
- General: Auth0, TypeScript, GraphQL, GraphQL-Codegen, GraphQL Inspector
New redesign (#4) * New redesign * Use latest nextjs and bob It fixes the start command * fix: text overflow issue in the organization switcher dropdown (#14) * fix: text overflow issue in the organization switcher dropdown * feat: strict children typings * Force dark mode (#15) If somebody used the light mode before, Hive App displays light version of tailwind classes * Fix dev, GH app optional, project type instead of Connected (#16) * Make Github integration optional * Show project type instead of Connected * Fix dev command * Small changes to the version card (#17) * Small changes to the version card * Apply suggestions from code review * Polish (#18) * Make the design a bit more clean * Add a bit of separation * Apply suggestions from code review Co-authored-by: Dimitri POSTOLOV <en3m@ya.ru> Co-authored-by: Dimitri POSTOLOV <en3m@ya.ru> * fix: do not access properties on potential undefined variable (#33) * fix: renaming not being added during rebase (#32) * feat: add Mutation.createToken validation (#30) * Remove `#` from organization pages, polish subcription page (#34) * Remove `#` from project/target pages (#38) * fix: add missing service names for multi service projects (#35) * Re-design subscription (#40) * Missing list of changes in the schema diff view (#41) * Missing list of changes in the schema diff view Closes #19 * Apply suggestions from code review Co-authored-by: Dimitri POSTOLOV <en3m@ya.ru> * Move titleMap outside of the component Co-authored-by: Dimitri POSTOLOV <en3m@ya.ru> * Blurred fixed header + new `404` page + use `@theguild/prettier-config` (#44) * fix header * make things amazing * Update packages/web/app/pages/404.tsx * fix build * remove unused styles * Add --fix to lint-staged (#43) * Fix access (#45) * Fix access on organization level * Fix access on project level * Fix access on target level * Align with main * Bring back schema view (#49) * Add missing Mark as Valid button (#50) * Update the design of the operations view (#51) * Update doc link Co-authored-by: Dotan Simha <dotansimha@gmail.com> Co-authored-by: Kamil Kisiela <kamil.kisiela@gmail.com> Co-authored-by: Laurin Quast <laurinquast@googlemail.com>
2022-05-24 07:41:53 +00:00
- Server: Node.js, GraphQL-Modules
- App: React, Next.js, Tailwind CSS, Radix Primitives
2022-05-18 07:26:57 +00:00
- CLI: Oclif
- Deployment: Pulumi, K8s, Nginx Proxy, Azure Cloud, CloudFlare Workers + KV Cache
2022-05-25 12:22:09 +00:00
- Monitoring: Promthues, Grafana, Sentry
2022-05-18 07:26:57 +00:00
- DB: Postgres, Redis, ClickHouse
## Docs
- [Deployment](./docs/DEPLOYMENT.md)
- [Development](./docs/DEVELOPMENT.md)
- [Testing](./docs/TESTING.md)