bima

README

Bima Framework

This repository contain only the framework, you can refer to skeleton for implementation

Bima Framework utilize gRPC Gateway to make REST easier and added some features for productivity.

Features

• gRPC Gateway

• CRUD Generator

• Authentication and Authorization (using Middleware)

• Support RDBMS (using Gorm) and MongoDB (using mgm)

• Soft Deletable (only for RDBMS)

• Support Elasticsearch and AMQP (Queue) Out of The Box

• Event Dispatcher

• Auto documentation (Swagger)

• Dependency Injection

• Two Level Middleware (Global or Per Route)

• Better Log Management

• Support Custom Route

• Support HTTP Compression Out of The Box

• Health Check

• Easy to Custom

Testing

go test -coverprofile /tmp/coverage ./... -v

Todo

• Documentation

Documentation

Index

• Constants
• type GormModel
• type Module
• type Server
  • func (s *Server) Consume(messenger *messengers.Messenger)
  • func (s *Server) Migrate(db *gorm.DB)
  • func (s *Server) RepopulateData(client *elastic.Client)

Constants

const (
	Version = "v3.2.0"

	HighestPriority = 255
	LowestPriority  = -255
)

Types

type GormModel

type GormModel struct {
	models.GormBase
}

type Module

type Module struct {
	Debug     bool
	Handler   *handlers.Handler
	Cache     *utils.Cache
	Paginator *paginations.Pagination
}

type Server

type Server struct {
	Debug bool
}

func (*Server) Consume

func (s *Server) Consume(messenger *messengers.Messenger)

func (*Server) Migrate

func (s *Server) Migrate(db *gorm.DB)

func (*Server) RepopulateData

func (s *Server) RepopulateData(client *elastic.Client)