graphql-engine/docs/graphql/core/getting-started/index.rst
hasura-bot 9b9bcf5a44 docs: improve getting started experience
GITHUB_PR_NUMBER: 6143
GITHUB_PR_URL: https://github.com/hasura/graphql-engine/pull/6143

Co-authored-by: Marion Schleifer <5722022+marionschleifer@users.noreply.github.com>
Co-authored-by: Rikin Kachhia <54616969+rikinsk@users.noreply.github.com>
GitOrigin-RevId: 7ad41cb9bc2c461ce04a30546e0214b9faebb085
2021-02-18 11:34:17 +00:00

58 lines
1.7 KiB
ReStructuredText

.. meta::
:description: Get started with Hasura
:keywords: hasura, docs, start
.. _getting_started:
Getting Started
===============
.. contents:: Table of contents
:backlinks: none
:depth: 1
:local:
Introduction
------------
To use the Hasura GraphQL engine, you need to:
- 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
Get started from scratch
------------------------
- :ref:`Using Hasura Cloud <cloud_getting_started>` **(recommended)**: Create
a new Hasura Cloud project with just a few clicks.
- :ref:`Using Docker <docker_simple>`: Run a **local development** setup that sets up both the Hasura GraphQL
engine and Postgres using Docker Compose.
Get started using an existing database
--------------------------------------
- :ref:`Using Hasura Cloud <cloud_getting_started>` **(recommended)**: Create a new Hasura Cloud project connected to an existing Postgres database.
- :ref:`Using Docker <deployment_docker>`: Run as a docker container and connect to an existing Postgres
database.
- :ref:`Using Kubernetes <deploy_kubernetes>`: Run on Kubernetes and connect to an existing Postgres
database.
.. admonition:: Supported Postgres versions
Hasura GraphQL engine supports **Postgres 9.5 and above**
.. admonition:: MySQL support (alpha)
Head to :ref:`this guide <mysql_preview>` to try out the MySQL preview.
.. toctree::
:maxdepth: 2
:titlesonly:
:hidden:
Hasura Cloud quickstart <https://hasura.io/docs/1.0/graphql/cloud/getting-started/index.html>
Docker quickstart <docker-simple>
Using an existing database <using-existing-database>