Install Hasura CLI
Depending on the platform, install Hasura CLI by following the steps in docs.
We will make use of Hasura CLI to manage the project locally. Start with an empty folder and execute the following command:
This will create a new project structure locally under the given directory (
hasura by default). This is how the directory structure looks:
├── config.yaml├── metadata│ ├── actions.graphql│ ├── actions.yaml│ ├── allow_list.yaml│ ├── cron_triggers.yaml│ ├── databases│ │ └── databases.yaml│ ├── query_collections.yaml│ ├── remote_schemas.yaml│ └── version.yaml├── migrations└── seeds
seeds directories are initally empty. The
metadata directory contains a bunch of yaml files each describing different parts of the GraphQL API, like the actions, remote schemas and the different databases that are connected to this project along with their tables and functions etc.
Since you have Hasura running locally via docker-compose, run the following command
This should open up the console on
http://localhost:9695 and is the same GUI as the one you see on the server console at
Connect a database
Once you are on the console, head to the
Data tab and navigate to
Connect Database section.
- Enter the database name as
- Choose the Environment Variable option to connect the database
- Enter the ENV name as
Connect Database to finish the database connection. This would now let you apply the migrations in the next step.
It should look something like the screen below:
- Build apps and APIs 10x faster
- Built-in authorization and caching
- 8x more performant than hand-rolled APIs