Codo Framework

Installation

go get github.com/codoworks/codo-framework

Quick Start

package main

import (
    "github.com/codoworks/codo-framework/core/config"
    "github.com/codoworks/codo-framework/core/db"
    "github.com/codoworks/codo-framework/core/http"
)

func main() {
    // Load configuration
    cfg, _ := config.Load()

    // Connect to database
    dbClient, _ := db.NewClient(cfg.Database)

    // Register handlers
    http.RegisterHandler(NewUserHandler(dbClient))

    // Start server
    router := http.NewRouter(http.ScopeProtected, cfg)
    router.Start()
}

Multi-Router Architecture

Core Packages

Creating a Handler

type UserHandler struct {
    service *UserService
}

func (h *UserHandler) Prefix() string           { return "/api/v1/users" }
func (h *UserHandler) Scope() http.RouterScope  { return http.ScopeProtected }
func (h *UserHandler) Middlewares() []echo.MiddlewareFunc { return nil }
func (h *UserHandler) Initialize() error        { return nil }

func (h *UserHandler) Routes(g *echo.Group) {
    g.GET("", http.WrapHandler(h.List))
    g.POST("", http.WrapHandler(h.Create))
    g.GET("/:id", http.WrapHandler(h.Get))
}

CLI Commands

codo serve              # Start all servers
codo start public       # Start public server only
codo start protected    # Start protected server only
codo db migrate         # Run migrations
codo db rollback        # Rollback migrations
codo db seed            # Run seeds
codo info routes        # Show registered routes
codo info env           # Show environment info

Documentation

License