* Update README.md fix discord link. * update cli readme and contributing guide
5.3 KiB
Hasura GraphQL Engine
Hasura GraphQL Engine is a blazing-fast GraphQL server that gives you instant GraphQL APIs over Postgres. 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.
- Make powerful queries: Built-in filtering, pagination, pattern search, bulk insert, update, delete mutations.
- 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.
Demos
- 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)
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.
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.
Support & Troubleshooting
The documentation and community will help you troubleshoot most issues. However, 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.
License
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.