gjango

README

golang gin with go-pg orm

An example project that uses golang gin as webserver, and go-pg library for connecting with a PostgreSQL database.

Get started

# postgresql config
cp .env.sample .env
source .env

# get dependencies and run
go get -v ./...
go run .

Tests and coverage

Run all tests

go test -coverprofile c.out ./...
go tool cover -html=c.out

# or simply
./test.sh

Run only integration tests

go test -v -run Integration ./...

./test.sh -i

Run only unit tests

go test -v -short ./...

# without coverage
./test.sh -s
# with coverage
./test.sh -s -c

Schema migration and cli management commands

# create a new database based on config values in .env
go run . create_db

# create our database schema
go run . create_schema

# create our superadmin user, which is used to administer our API server
go run . create_superadmin

# schema migration and subcommands are available in the migrate subcommand
# go run . migrate [command]

Documentation

Index

• type Gjango
  • func New() *Gjango
  • func (g *Gjango) Run()
  • func (g *Gjango) WithRoutes(RouteServices ...route.ServicesI) *Gjango

Types

type Gjango

type Gjango struct {
	RouteServices []route.ServicesI
}

Gjango allows us to specify customizations, such as custom route services

func New

func New() *Gjango

New creates a new Gjango instance

func (*Gjango) Run

func (g *Gjango) Run()

Run executes our gjango functions or servers

func (*Gjango) WithRoutes

func (g *Gjango) WithRoutes(RouteServices ...route.ServicesI) *Gjango

WithRoutes is the builder method for us to add in custom route services