chaki

README

Chaki

Chaki is an application builder framework designed to simplify the development process in Go by abstracting processes such as tracing, logging, Kafka integration, and Swagger documentation. It reduces the amount of boilerplate code, enhancing developer experience and productivity. Chaki handles complex tasks for you, allowing you to focus more on the core functionalities of your application.

Using Chaki, you can:

• Easily integrate the technologies and tools into your project with just a few configuration definitions.
• Quickly adapt to technological changes minumum effort on your stack, while continuing with your existing workflow.
• Create projects with code that primarily contains business logic, freeing you from technical bootstrap components.

Usage

A simple usage example is provided below. For more detailed examples, please refer to the examples directory.

func main() {
	// create instance
	app := chaki.New()

	// add modules
	app.Use(
	 foomodule.Module(),
	)

	// provide constructors
	app.Provide(
	  NewFooRepository,
	  NewFooService,
	  NewBarClient,
	  NewFooController,
	  NewFooCreatedConsumer,
	  // or you can just provide an already created instance
	  chaki.Valuer(barRepositoryInstance),
	)

	// start application
	if err := app.Start(); err != nil {
	    logger.Fatal(err)
	}
}

Modules

Chaki is fundamentally based on the uber-go/fx dependency injection system and includes additional features such as a module system. This framework, built on a simple foundation, derives much of its power from its modules.

• Modules are easily added to the system with app.Use.
• Once added, you can directly use instances produced by the module, such as *gorm.Gorm or sarama.SyncProducer, in any constructor you want.
• Modules can be easily configured using configuration files.

Documentation

Index

• func Invoke(ctr ...any)
• func Provide(ctr ...any)
• func Replacer[T any](t T) func(T) T
• func Start(p ...Option) error
• func Valuer[T any](t T) func() T
• type App
  • func New() *App
  • func (app *App) Invoke(ctr ...any) *App
  • func (app *App) Provide(ctr ...any) *App
  • func (app *App) Start(opts ...Option) error
  • func (app *App) Use(modules ...*module.Module)
  • func (app *App) WithOption(opts ...Option) *App
• type Option
  • func WithConfigDisabled(disabled bool) Option
  • func WithConfigPath(path string) Option
  • func WithConfigReferencePath(key, path string) Option
  • func WithTimeout(t time.Duration) Option

Functions

func Invoke

func Invoke(ctr ...any)

func Provide

func Provide(ctr ...any)

func Replacer

func Replacer[T any](t T) func(T) T

func Start

func Start(p ...Option) error

func Valuer

func Valuer[T any](t T) func() T

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func New

func New() *App

func (*App) Invoke

func (app *App) Invoke(ctr ...any) *App

func (*App) Provide

func (app *App) Provide(ctr ...any) *App

func (*App) Start

func (app *App) Start(opts ...Option) error

func (*App) Use

func (app *App) Use(modules ...*module.Module)

func (*App) WithOption

func (app *App) WithOption(opts ...Option) *App

type Option

type Option interface {
	Apply(*options)
}

func WithConfigDisabled

func WithConfigDisabled(disabled bool) Option

func WithConfigPath

func WithConfigPath(path string) Option

func WithConfigReferencePath

func WithConfigReferencePath(key, path string) Option

func WithTimeout

func WithTimeout(t time.Duration) Option