core

README

core

⚙️ Core module shared across our backend projects

Installation

Adding core to a Go project is as easy as calling this command

go get github.com/cozy-hosting/core

Using the module

The project must be based on the uber-go/fx application framework

package main

import "go.uber.org/fx"

func main() {
    // Creates a new fx application
    fx.New(
        // Add the core module to the container
        core.Module,
        fx.Invoke(
            // Add this, if you want to use SwaggerUI
            core.UseSwagger,
            // Also add this, if you want to use GraphQL + Playground
            core.UseGraphQlWithPlayground,
        ),
    ).Run()
}

Contained sub-modules

The list of uber/fx modules that are currently available:

• Logrus - https://github.com/sirupsen/logrus
• Clerk database (MongoDB) - https://github.com/cozy-hosting/clerk
• Messenger messaging queue (RabbitMQ) - https://github.com/cozy-hosting/messenger
• Labstack Echo webserver - https://github.com/labstack/echo
• Swagger UI trough swag - https://github.com/swaggo/swag
• GraphQL Schema / Handling - https://github.com/graphql-go/graphql

Documentation

Index

• Variables
• func IsDevelopment() bool
• func NewClerkConnection(lifecycle fx.Lifecycle, logger *logrus.Logger) clerk.Connection
• func UseEcho(lifecycle fx.Lifecycle, logger *logrus.Logger) *echo.Echo
• func UseEnvironment(logger *logrus.Logger)
• func UseGraphQl(schema *graphql.Schema, server *echo.Echo, logger *logrus.Logger)
• func UseGraphQlWithPlayground(schema *graphql.Schema, server *echo.Echo, logger *logrus.Logger)
• func UseLogrus() *logrus.Logger
• func UseSwagger(server *echo.Echo)

Variables

var ClerkModule = fx.Provide(
	NewClerkConnection,
)

var EchoModule = fx.Provide(
	UseEcho,
)

var GraphQlModule = fx.Provide(
	fx.Annotated{
		Name:   "query",
		Target: newGraphQlQuery,
	},
	fx.Annotated{
		Name:   "mutation",
		Target: newGraphQlMutation,
	},
	newGraphQlSchema,
)

var LogrusModule = fx.Provide(
	UseLogrus,
)

var MessengerModule = fx.Provide(
	newMessenger,
)

var Module = fx.Options(
	LogrusModule,
	ClerkModule,
	MessengerModule,
	EchoModule,
	GraphQlModule,
	fx.Invoke(
		UseEnvironment,
	),
)

Functions

func IsDevelopment

func IsDevelopment() bool

func NewClerkConnection

func NewClerkConnection(lifecycle fx.Lifecycle, logger *logrus.Logger) clerk.Connection

func UseEcho

func UseEcho(lifecycle fx.Lifecycle, logger *logrus.Logger) *echo.Echo

func UseEnvironment

func UseEnvironment(logger *logrus.Logger)

func UseGraphQl

func UseGraphQl(schema *graphql.Schema, server *echo.Echo, logger *logrus.Logger)

func UseGraphQlWithPlayground

func UseGraphQlWithPlayground(schema *graphql.Schema, server *echo.Echo, logger *logrus.Logger)

func UseLogrus

func UseLogrus() *logrus.Logger

func UseSwagger

func UseSwagger(server *echo.Echo)