Hasurify Backend

Hasura + Serverless functions for Hasurify System.

Getting Started

First at all, please download and install Docker Desktop and enable Kubernetes in preferences.

Setup

We have two ways to setup and build the local environment, use make command and manual setup

Copy .env.example to .env at root directory and each function directory.

Using Make command

Setup and build local environment:

See how can generate a personal token here https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token

# Export NPM_TOKEN or you should put it into your zshrc file
$ export NPM_TOKEN=<NPM_TOKEN>

$ echo -e "//npm.pkg.github.com/:_authToken=$NPM_TOKEN\n\
@hasurify:registry=https://npm.pkg.github.com/" > ~/.npmrc

# Clear all docker images, this command might have the error
$ make stack/infra/purge
# Run setup
$ make setup
$ make hasura/apply-all

Start and leave your work

$ make work
$ make leave

Restart all functions

$ stack/functions/restart

Rebuild all functions

$ stack/functions/buildup

Manual Setup

Installing the Hasura CLI

In your Terminal, run the following command:

curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | bash

Running development instance

Copy default environment variables:

cp .env.example .env

Run Harura and PostgreSQL by following command:

docker-compose up

Development

Creating new database migration

$ cd hasura
$ hasura migrate create migration-name --up-sql "CREATE TABLE users(id serial NOT NULL, username varchar NOT NULL, email varchar NOT NULL, email_verified boolean DEFAULT false, phone_verified boolean DEFAULT false, status int NOT NULL DEFAULT 0);"  --down-sql "DROP TABLE users;"

Apply migration and seeder by running:

$ cd hasura
$ hasura migrate apply
$ hasura seeds apply

Add table to metadata/tables.yaml

- table:
    schema: public
    name: users

Apply the metadata by running:

$ hasura metadata apply

Hasura Console

Open API explorer at http://localhost:8090/console/api-explorer. See the admin secret in the env file, key HASURA_GRAPHQL_ADMIN_SECRET

Run GraphQL query

query {
  users {
    id
    email
  }
}

Creating new function

faas-cli new function_name --lang node-typescript

Install/uninstall new NPM package for all functions

# Uninstall
$ make node/uninstall/package p=<package_name>
# Install
$ make node/install/package p=<package_name>

Makefile commands

Stack Targets:

  stack/network/create Creates the docker network (checks if it exists first).
  stack/network/recreate Destroys and re-creates the docker network.
  stack/infra/up Bring only the infrastructure containers UP
  stack/infra/down Bring only the infrastructure containers DOWN (does not touch the module services).
  stack/infra/restart Restart only the infrastructure containers.
  stack/all/buildrestart Re-builds and re-starts ALL functions including infrastructure services.
  stack/infra/downdeletevolumes Bring only the infrastructure containers DOWN (does not touch the module services) + DELETE data volumes.
  node/remove/all Remove node_modules across all functions.
  node/install/all Install node_modules across all functions.
  node/install/package Install a specific node module with @latest (requires PACKAGE p) across all functions
  node/uninstall/package Uninstall a specific node module with @latest (requires PACKAGE p) across all functions
  env/clone  Clone env file
  stack/status Displays the output of docker.

Function Targets:

  stack/functions/down            Bring only the functions DOWN (not the main dependencies like postgres, elasticsearch, etc).
  stack/functions/up              Bring only the functions UP (not the main dependencies like postgres, graphql-engine, etc).
  stack/functions/restart         Restart all functions
  stack/functions/buildup         Build and start all containers

Hasura Targets:

  hasura/install                 # Install Hasura CLI
  hasura/apply-all               # Apply Hasura and reload migrations and reload metadata
  hasura/apply-metadata          # Apply and reload only Hasura metadata

Troubleshooting

If you can't run Makefile to build the serverless functions or some errors occur, please run the following command to build it again:

$ cd functions/user
# Build function
$ cp .env.example .env
$ cp .npmrc.example .npmrc # Change your NPM TOKEN
$ docker-compose up -d

If you're using Windows OS and can't setup using Linux commands, please try to use Linux portable inside the OS. See details below:

• Linux on Windows: https://www.youtube.com/watch?v=LLlfLpvQg04
• Terminal: https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab#

You might need to restart your local machine if some error occurs when first time setup.