| .circleci | ||
| .github | ||
| assets | ||
| cli | ||
| community | ||
| console | ||
| docs | ||
| install-manifests | ||
| scripts | ||
| server | ||
| .ciignore | ||
| .gitignore | ||
| code-of-conduct.md | ||
| CONTRIBUTING.md | ||
| event-triggers.md | ||
| LICENSE | ||
| LICENSE-community | ||
| README.md | ||
Hasura GraphQL Engine
Hasura GraphQL Engine is a blazing-fast GraphQL server that gives you instant, realtime GraphQL APIs over Postgres, with webhook triggers on database events for asynchronous business logic.
Hasura helps you build GraphQL apps backed by Postgres or incrementally move to GraphQL for existing applications using Postgres.
Read more at hasura.io and the docs.
Features
- Make powerful queries: Built-in filtering, pagination, pattern search, bulk insert, update, delete mutations
- Realtime: Convert any GraphQL query to a live query by using subscriptions
- Trigger webhooks or serverless functions: On Postgres insert/update/delete events (read more)
- Works with existing, live databases: Point it to an existing Postgres database to instantly get a ready-to-use GraphQL API
- Fine-grained access control: Dynamic access control that integrates with your auth system (eg: auth0, firebase-auth)
- High-performance & low-footprint: ~15MB docker image; ~50MB RAM @ 1000 req/s; multi-core aware
- Admin UI & Migrations: Admin UI & Rails-inspired schema migrations
- Postgres ❤️: Supports Postgres types (PostGIS/geo-location, etc.), turns views to graphs, trigger stored functions or procedures with mutations
Read more at https://hasura.io and the docs.
Table of contents
Table of Contents
- Quickstart:
- Architecture
- Client-side tooling
- Add business logic
- Demos
- Support & Troubleshooting
- Contributing
- Brand assets
- License
Quickstart:
One-click deployment on Heroku
The fastest way to try Hasura out is via Heroku.
-
Click on the following button to deploy GraphQL Engine on Heroku with the free Postgres add-on:
-
Open the Hasura console
Visit
https://<app-name>.herokuapp.com(replace <app-name> with your app name) to open the admin console. -
Make your first GraphQL query
Create a table and instantly run your first query. Follow this simple guide.
Other deployment methods
For Docker-based deployment and advanced configuration options, see deployment guides or install manifests.
Architecture
The Hasura GraphQL Engine fronts a Postgres database instance and can accept GraphQL requests from your client apps. It can be configured to work with your existing auth system and can handle access control using field-level rules with dynamic variables from your auth system.
You can also place the engine behind a central GraphQL proxy that fronts multiple GraphQL APIs via schema stitching.
Client-side tooling
Hasura works with any GraphQL client. We recommend using Apollo Client. See awesome-graphql for a list of clients.
Add business logic
Custom resolvers
Add custom resolvers in addition to Hasura GraphQL engine. Ideal for delegating to HTTP APIs, making direct calls to another data-source or writing business logic in code - read more.
Trigger webhooks on database events
Add asynchronous business logic that is triggered based on database events. Ideal for notifications, data-pipelines from Postgres or asynchronous processing - read more.
Demos
Check out all the example applications in the community/examples directory.
Realtime applications
-
Group Chat application built with React, includes a typing indicator, online users & new message notifications.
-
Live location tracking app that shows a running vehicle changing current GPS coordinates moving on a map.
-
A realtime dashboard for data aggregations on continuously changing data.
Videos
- Add GraphQL to a self-hosted GitLab instance (3:44 mins)
- Todo app with Auth0 and GraphQL backend (4:00 mins)
- GraphQL on GitLab integrated with GitLab auth (4:05 mins)
- Dashboard for 10million rides with geo-location (PostGIS, Timescale) (3:06 mins)
Support & Troubleshooting
The documentation and community will help you troubleshoot most issues. If you have encountered a bug or need to get in touch with us, you can contact us using one of the following channels:
- Support & feedback: Discord
- Issue & bug tracking: GitHub issues
- Follow product updates: @HasuraHQ
- Talk to us on our website chat
We are committed to fostering an open and welcoming environment in the community. Please see the Code of Conduct.
Contributing
Check out our contributing guide for more details.
Brand assets
Hasura brand assets (logos, the Hasura mascot, powered by badges etc.) can be found in the assets/brand folder. Feel free to use them in your application/website etc. We'd be thrilled if you add the "Powered by Hasura" badge to your applications built using Hasura. ❤️
<!-- For light backgrounds -->
<a href="https://hasura.io">
<img width="150px" src="https://graphql-engine-cdn.hasura.io/img/powered_by_hasura_black.svg" />
</a>
<!-- For dark backgrounds -->
<a href="https://hasura.io">
<img width="150px" src="https://graphql-engine-cdn.hasura.io/img/powered_by_hasura_white.svg" />
</a>
License
The core GraphQL Engine is available under the GNU Affero General Public License v3 (AGPL-3.0), the same license as MongoDB. We have written more about what you can and cannot do under AGPL here.
Commercial licenses that bundle the Hasura GraphQL Engine with support and SLAs are available on request. Please feel free to contact us at build@hasura.io or on our website chat.
All other contents (except those in server, cli and
console directories) are available under the MIT License.
This includes everything in the docs and community
directories.