forge

README

WIP

🔥 Forge

A Go library/tool for building backend for fullstack apps.

Usage

Forge can be used either directly as a tool or as a library.

As a tool

1. Download & unpack a Go release from releases section.
2. Tune the forge.yml file as per your needs.
3. Run ./forge serve -c forge.yml

If you have frontend build, use --static=./ui to serve as static files.

As a library [Goal]

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/spy16/forge"
	"github.com/spy16/forge/builtins/firebase"
	"github.com/spy16/forge/core"
)

func main() {
	cli := forge.CLI("myapp",
		forge.WithAuth(&firebase.Auth{
			ProjectID: "foo",
		}),
		forge.WithPostHook(func(app core.App, conf core.ConfigLoader) error {
			r := app.Chi()
			r.Use(app.Authenticate())
			r.Get("/api/my-endpoint", func(w http.ResponseWriter, r *http.Request) {
				// Only accessible with firebase auth token
            })
			return nil
		}),
	)
	_ = cli.Execute()
}

Documentation

Index

• func CLI(name string, forgeOpts ...Option) *cobra.Command
• func Forge(name string, opts ...Option) (chi.Router, error)
• type Middleware
• type Option
  • func WithConfLoader(confL core.ConfLoader) Option
  • func WithPostHook(hook func(app PostContext) error) Option
  • func WithPreHook(hook func(app PreContext) error) Option
• type PostContext
• type PreContext

Functions

func CLI

func CLI(name string, forgeOpts ...Option) *cobra.Command

CLI returns a new Cobra CLI that can be used directly.

func Forge

func Forge(name string, opts ...Option) (chi.Router, error)

Forge forges a new application using given options. If 'conf' is nil, viper-based config loader will be initialised. Config file discovery will be done based on the 'name'.

Types

type Middleware

type Middleware func(http.Handler) http.Handler

type Option

type Option func(app *appForge) error

Option can be passed to Forge() to control the forging process.

func WithConfLoader

func WithConfLoader(confL core.ConfLoader) Option

WithConfLoader can be used to set a custom config loader.

func WithPostHook

func WithPostHook(hook func(app PostContext) error) Option

WithPostHook can be used to set a post-hook for Forge(). This hook will be invoked when all modules and base router is initialised. This can be used to set-up additional routes, etc.

func WithPreHook

func WithPreHook(hook func(app PreContext) error) Option

WithPreHook can be used to set a pre-hook for Forge(). This hook will be invoked when config-loader is initialized. Auth and other modules can be initialized here.

type PostContext

type PostContext interface {
	Auth() core.Auth
	Router() chi.Router
	Configs() core.ConfLoader
	Authenticate() Middleware
}

PostContext is the app state after fully initialised.

type PreContext

type PreContext interface {
	Configs() core.ConfLoader
	SetAuth(auth core.Auth)
	SetRouter(r chi.Router)
}

PreContext is the app state before fully initialised.