mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-09-11 10:46:25 +03:00
update readme, add newsletter link to docs
> ### Description > This PR updates the readme.md of the repo, removing some old stuff and updating contents to reflect Hasura's latest features and offerings from v2.0. ### Changelog - [x] `CHANGELOG.md` is updated with user-facing content relevant to this PR. If no changelog is required, then add the `no-changelog-required` label. ### Affected components - [x] Docs https://github.com/hasura/graphql-engine-mono/pull/2190 GitOrigin-RevId: a51654a6893a66e2d2c7816018c8bccb5ff0eea9
This commit is contained in:
Praveen Durairaju
hasura-bot
parent
5cba4fd079
commit
77842fffe0
35
README.md
35
README.md
@ -1,17 +1,13 @@
|
||||
# Hasura GraphQL Engine
|
||||
|
||||
[](https://github.com/hasura/graphql-engine/releases/latest)
|
||||
[](https://hasura.io/docs)
|
||||
[](https://circleci.com/gh/hasura/graphql-engine)
|
||||
|
||||
[](https://hasura.io/docs)
|
||||
|
||||
<a href="https://discord.gg/vBPpJkS"><img src="https://img.shields.io/badge/chat-discord-brightgreen.svg?logo=discord&style=flat"></a>
|
||||
<a href="https://twitter.com/intent/follow?screen_name=HasuraHQ"><img src="https://img.shields.io/badge/Follow-HasuraHQ-blue.svg?style=flat&logo=twitter"></a>
|
||||
<a href="https://hasura.io/newsletter/"><img src="https://img.shields.io/badge/newsletter-subscribe-yellow.svg?style=flat"></a>
|
||||
|
||||
Hasura GraphQL Engine is a blazing-fast GraphQL server that gives you **instant, realtime GraphQL APIs over Postgres**, with [**webhook triggers**](event-triggers.md) on database events, and [**remote schemas**](remote-schemas.md) for business logic.
|
||||
|
||||
Hasura helps you build [GraphQL](https://hasura.io/graphql/) apps backed by Postgres or incrementally move to GraphQL for existing applications using Postgres.
|
||||
Hasura is an open source product that accelerates API development by 10x by giving you [GraphQL](https://hasura.io/graphql/) or REST APIs with built in authorization on your data, instantly.
|
||||
|
||||
Read more at [hasura.io](https://hasura.io) and the [docs](https://hasura.io/docs/).
|
||||
|
||||
@ -28,14 +24,15 @@ Read more at [hasura.io](https://hasura.io) and the [docs](https://hasura.io/doc
|
||||
## Features
|
||||
|
||||
* **Make powerful queries**: Built-in filtering, pagination, pattern search, bulk insert, update, delete mutations
|
||||
* **Works with existing, live databases**: Point it to an existing database to instantly get a ready-to-use GraphQL API
|
||||
* **Realtime**: Convert any GraphQL query to a live query by using subscriptions
|
||||
* **Merge remote schemas**: Access custom GraphQL schemas for business logic via a single GraphQL Engine endpoint. [**Read more**](remote-schemas.md).
|
||||
* **Extend with Actions**: Write REST APIs to extend Hasura’s schema with custom business logic.
|
||||
* **Trigger webhooks or serverless functions**: On Postgres insert/update/delete events ([read more](event-triggers.md))
|
||||
* **Works with existing, live databases**: Point it to an existing Postgres database to instantly get a ready-to-use GraphQL API
|
||||
* **Scheduled Triggers**: Execute custom business logic at specific points in time using a cron config or a one-off event.
|
||||
* **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
|
||||
* **Supported Databases**: Supports PostgreSQL (and its flavours), MS SQL Server and Big Query. Support for more [databases](https://hasura.io/graphql/database/) coming soon.
|
||||
|
||||
Read more at [hasura.io](https://hasura.io) and the [docs](https://hasura.io/docs/).
|
||||
|
||||
@ -56,6 +53,7 @@ Read more at [hasura.io](https://hasura.io) and the [docs](https://hasura.io/doc
|
||||
- [Realtime applications](#realtime-applications)
|
||||
- [Videos](#videos)
|
||||
- [Support & Troubleshooting](#support--troubleshooting)
|
||||
- [Stay up to date](#stay-up-to-date)
|
||||
- [Contributing](#contributing)
|
||||
- [Brand assets](#brand-assets)
|
||||
- [License](#license)
|
||||
@ -67,7 +65,7 @@ Read more at [hasura.io](https://hasura.io) and the [docs](https://hasura.io/doc
|
||||
|
||||
### One-click deployment on Hasura Cloud
|
||||
|
||||
The fastest and easiest way to try Hasura out is via [Hasura Cloud](https://hasura.io/docs/cloud/1.0/manual/getting-started/index.html).
|
||||
The fastest and easiest way to try Hasura out is via [Hasura Cloud](https://hasura.io/docs/latest/graphql/cloud/getting-started/index.html).
|
||||
|
||||
1. Click on the following button to deploy GraphQL engine on Hasura Cloud including Postgres add-on or using an existing Postgres database:
|
||||
|
||||
@ -108,7 +106,7 @@ You can also merge remote GraphQL schemas and provide a unified GraphQL API.
|
||||
|
||||
## Client-side tooling
|
||||
|
||||
Hasura works with any GraphQL client. We recommend using [Apollo Client](https://github.com/apollographql/apollo-client). See [awesome-graphql](https://github.com/chentsulin/awesome-graphql) for a list of clients.
|
||||
Hasura works with any GraphQL client. See [awesome-graphql](https://github.com/chentsulin/awesome-graphql) for a list of clients. Our [frontend tutorial series](https://hasura.io/learn/#frontend-tutorial) also have integrations with GraphQL clients for different frameworks.
|
||||
|
||||
## Add business logic
|
||||
|
||||
@ -116,7 +114,11 @@ GraphQL Engine provides easy-to-reason, scalable and performant methods for addi
|
||||
|
||||
### Remote schemas
|
||||
|
||||
Add custom resolvers in a remote schema in addition to Hasura's Postgres-based GraphQL schema. Ideal for use-cases like implementing a payment API, or querying data that is not in your database - [read more](remote-schemas.md).
|
||||
Add custom resolvers in a remote schema in addition to Hasura's database-based GraphQL schema. Ideal for use-cases like implementing a payment API, or querying data that is not in your database - [read more](remote-schemas.md).
|
||||
|
||||
### Actions
|
||||
|
||||
Actions are a way to extend Hasura’s schema with custom business logic using custom queries and mutations. Actions can be added to Hasura to handle various use cases such as data validation, data enrichment from external sources and any other complex business logic - [read more](https://hasura.io/docs/latest/graphql/core/actions/index.html)
|
||||
|
||||
### Trigger webhooks on database events
|
||||
|
||||
@ -138,18 +140,15 @@ Check out all the example applications in the [community/sample-apps](community/
|
||||
message notifications.
|
||||
- [Try it out](https://realtime-chat.demo.hasura.app/)
|
||||
- [Tutorial](community/sample-apps/realtime-chat)
|
||||
- [Browse APIs](https://realtime-chat.demo.hasura.app/console)
|
||||
|
||||
- Live location tracking app that shows a running vehicle changing current GPS
|
||||
coordinates moving on a map.
|
||||
- [Try it out](https://realtime-location-tracking.demo.hasura.app/)
|
||||
- [Tutorial](community/sample-apps/realtime-location-tracking)
|
||||
- [Browse APIs](https://realtime-location-tracking.demo.hasura.app/console)
|
||||
|
||||
- A realtime dashboard for data aggregations on continuously changing data.
|
||||
- [Try it out](https://realtime-poll.demo.hasura.app/)
|
||||
- [Tutorial](community/sample-apps/realtime-poll)
|
||||
- [Browse APIs](https://realtime-poll.demo.hasura.app/console)
|
||||
|
||||
### Videos
|
||||
|
||||
@ -158,7 +157,6 @@ Check out all the example applications in the [community/sample-apps](community/
|
||||
* [GraphQL on GitLab integrated with GitLab auth](https://www.youtube.com/watch?v=m1ChRhRLq7o) (*4:05 mins*)
|
||||
* [Dashboard for 10million rides with geo-location (PostGIS, Timescale)](https://www.youtube.com/watch?v=tsY573yyGWA) (*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:
|
||||
@ -172,6 +170,11 @@ We are committed to fostering an open and welcoming environment in the community
|
||||
|
||||
If you want to report a security issue, please [read this](SECURITY.md).
|
||||
|
||||
## Stay up to date
|
||||
|
||||
We release new features every month. Sign up for our newsletter by using the link below. We send newsletters only once a month.
|
||||
[https://hasura.io/newsletter/](https://hasura.io/newsletter/)
|
||||
|
||||
## Contributing
|
||||
|
||||
Check out our [contributing guide](CONTRIBUTING.md) for more details.
|
||||
|
||||
@ -136,6 +136,12 @@ Learn course
|
||||
|
||||
For a full hands-on tour of Hasura, check out our `30-Minute Hasura Basics Course <https://hasura.io/learn/graphql/hasura/introduction/>`__.
|
||||
|
||||
Stay up to date
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
We release new features every month. Sign up for our newsletter by using the link below. We send newsletters only once a month.
|
||||
`https://hasura.io/newsletter/ <https://hasura.io/newsletter/>`__.
|
||||
|
||||
Database operations
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user