2020-01-14 15:57:45 +03:00
.. meta ::
:description: Get started with Hasura
:keywords: hasura, docs, start
2020-03-11 22:42:36 +03:00
.. _getting_started:
2020-07-08 00:47:42 +03:00
Getting Started
2018-09-11 14:11:24 +03:00
===============
2018-12-03 15:12:24 +03:00
.. contents :: Table of contents
:backlinks: none
:depth: 1
:local:
2020-07-31 18:26:55 +03:00
Introduction
------------
2018-09-11 14:11:24 +03:00
2020-07-31 18:26:55 +03:00
To use the Hasura GraphQL engine, you need to:
2018-09-11 14:11:24 +03:00
2020-07-31 18:26:55 +03:00
- Deploy the Hasura GraphQL engine with access to a Postgres database
- Set up and test your GraphQL API using the Hasura console UI *(also possible via the CLI or API)*
- Consume the generated GraphQL API from your client apps
2018-09-11 14:11:24 +03:00
2019-05-17 15:03:35 +03:00
Get started from scratch
------------------------
2018-09-11 14:11:24 +03:00
2020-07-31 18:26:55 +03:00
- `Using Hasura Cloud <https://hasura.io/docs/cloud/1.0/manual/getting-started/index.html> `__ **(recommended)** : Create
a new Hasura Cloud project with just a few clicks.
2020-03-11 22:42:36 +03:00
- :ref: `Using Docker <docker_simple>` : Run a **local development** setup that sets up both the Hasura GraphQL
2020-07-31 18:26:55 +03:00
engine and Postgres using Docker Compose.
2018-09-11 14:11:24 +03:00
2019-05-17 15:03:35 +03:00
Get started using an existing database
--------------------------------------
2018-12-03 15:12:24 +03:00
2020-07-14 20:56:56 +03:00
- `Using Hasura Cloud <https://hasura.io/docs/cloud/1.0/manual/getting-started/index.html> `__ **(recommended)** : Create a new Hasura Cloud project connected to an existing Postgres database.
2020-03-11 22:42:36 +03:00
- :ref: `Using Docker <deployment_docker>` : Run as a docker container and connect to an existing Postgres
2018-09-11 14:11:24 +03:00
database.
2020-03-11 22:42:36 +03:00
- :ref: `Using Kubernetes <deploy_kubernetes>` : Run on Kubernetes and connect to an existing Postgres
2018-09-11 14:11:24 +03:00
database.
2019-09-09 11:35:39 +03:00
.. admonition :: Supported Postgres versions
2019-09-23 10:07:42 +03:00
Hasura GraphQL engine supports **Postgres 9.5 and above**
2019-09-09 11:35:39 +03:00
2018-09-11 14:11:24 +03:00
.. toctree ::
:maxdepth: 2
:titlesonly:
:hidden:
2020-07-07 14:43:59 +03:00
Hasura Cloud quickstart <https://hasura.io/docs/cloud/1.0/manual/getting-started/index.html>
2018-09-11 14:11:24 +03:00
Docker quickstart <docker-simple>
Using an existing database <using-existing-database>
first-graphql-query
first-event-trigger
2018-12-16 12:55:06 +03:00