johnrazeur / go-graphql-api-boilerplate

A Boilerplate of GraphQL API built with Go

Go GraphQL API Boilerplate

Stacks

• Go
• GraphQL : graphql-go
• ORM : gorm

Features

• User Sign Up & Sign In
• Change a Password, Profile

How to Run

Initialize DB

1. Create a database

postgres=# CREATE DATABASE go;

2. Create a user as owner of database

postgres=# CREATE USER go WITH ENCRYPTED PASSWORD 'go';

postgres=# ALTER DATABASE go OWNER TO go;

3. Grant all privileges to user for the database

postgres=# GRANT ALL PRIVILEGES ON DATABASE go TO go;

4. Configure the db in db.go

// ConnectDB : connecting DB
func ConnectDB() (*DB, error) {
	db, err := gorm.Open("postgres", "host=localhost port=5432 user=go dbname=go password=go sslmode=disable")

	if err != nil {
		panic(err)
	}

	return &DB{db}, nil
}

Initial Migration

$ go run ./migrations/init.go

or with docker

$ docker run --rm go-graphql-api migrate

This will generate the users table in the database as per the User Model declared in ./model/user.go Model

Run the server

$ go run server.go

or with docker

$ docker build -t go-graphql-api .
$ docker run -p 8080:8080 go-graphql-api

GraphQL Playground

Connect to http://localhost:8080

Authentication : JWT

You need to set the Http request headers Authorization: {JWT_token}

Usage

Sign Up

mutation {
  signUp(
    email: "[email protected]"
    password: "12345678"
    firstName: "graphql"
    lastName: "go"
  ) {
    ok
    error
    user {
      id
      email
      firstName
      lastName
      bio
      avatar
      createdAt
      updatedAt
    }
  }
}

Sign In

mutation {
  signIn(email: "[email protected]", password: "12345678") {
    ok
    error
    token
  }
}

Change a Password

mutation {
  changePassword(userID: 1, password: "87654321") {
    ok
    error
    user {
      id
      email
      firstName
      lastName
      bio
      avatar
      createdAt
      updatedAt
    }
  }
}

Change a Profile

mutation {
  changeProfile(userID: 1, bio: "Go developer", avatar: "go-developer.png") {
    ok
    error
    user {
      id
      email
      firstName
      lastName
      bio
      avatar
      createdAt
      updatedAt
    }
  }
}

Get my profile

query {
  getMyProfile {
    ok
    error
    user {
      id
      email
      firstName
      lastName
      bio
      avatar
      createdAt
      updatedAt
    }
  }
}

Next to do

• Sign-Up
• Query the profile with implementing context.Context
• Sign-In with JWT
• Change the password
• Change the profile
• Using Configuration file for DB & JWT secret_key
• Making schema automation