photon

README

Photon

Photon is a lightweight and extensible backend framework for Go. Built with a modular, adapter-based architecture, Photon enables developers to create robust HTTP and WebSocket applications with clarity and flexibility.

---

✨ Features

• Modular Adapters: Seamlessly switch between HTTP and WebSocket backends (e.g., Echo, Melody).
• Plug-and-Play Architecture: Easy integration of custom adapters.
• Minimalistic Core: No hidden magic — full transparency and maintainability.

---

🚀 Installation

go get github.com/smtdfc/photon
go install github.com/smtdfc/photon-cli

---

⚙️ Getting Started

1. Create a new Echo-based Photon app

go mod init example.com/hello
photon gen app hello

2. Generate a module

photon gen module hello

3. Define your module routes

In internal/hello/init.go:

package hello

func (m *HelloModule) InitRoute() {
    m.Module.Route("GET", "/hello", m.Handler.Hello)
}

In internal/hello/handler.go:

package hello

import "github.com/smtdfc/photon"

type HelloModuleHandler struct{}

func (h *HelloModuleHandler) Hello(req photon.Request, res photon.Response) {
    res.JSON(200, map[string]any{
        "message": "Hello World 🚀",
    })
}

Register the module in your app:

package app

import (
    "github.com/smtdfc/photon"
    "example.com/hello/internal/hello"
)

func InitModule(app *photon.App) {
    hello.Init(app)
}

4. Run the app

go run .

Access it at: http://127.0.0.1:3000/hello

---

🔌 Custom Adapter Development

Photon adapters must implement the following interfaces:

BaseHTTPAdapter

type BaseHTTPAdapter interface {
    GetName() string
    Init() error
    Start() error
    Listen(port string) error
    UseSocket(path string, socketAdapter BaseSocketAdapter) error
    Route(method string, path string, handler RouteHandler)
}

BaseSocketAdapter

type BaseSocketAdapter interface {
    GetName() string
    Init() error
    Start() error
    On(event string, handler SocketEventHandler)
    Emit(event string, data []byte) error
    Stop() error
    HTTPHandler() func(http.ResponseWriter, *http.Request)
}

---

📆 Ecosystem

• 🔗 Echo Adapter
• 🔗 Melody Adapter
• 🛠️ Photon CLI

---

📜 License

Photon is licensed under the MIT License. © 2025 smtdfc

Documentation

Index

• func Inject[T any](target Module, edge string) T
• func InjectTo(edge string, target Module, provider Provider)
• type App
  • func CreateApp() *App
  • func (a *App) Start(port string) error
• type Logger
  • func CreateLogger(target string) *Logger
  • func (l *Logger) Debug(msg string)
  • func (l *Logger) Error(msg string)
  • func (l *Logger) Fatal(msg string)
  • func (l *Logger) Info(msg string)
  • func (l *Logger) Warn(msg string)
• type Module
  • func (m *Module) GetInject(edge string) any
  • func (m *Module) GetProvide() any
  • func (m *Module) Inject(edge string, provider Provider)
  • func (m *Module) Provide(value any)
• type Provider

Functions

func Inject

func Inject[T any](target Module, edge string) T

func InjectTo

func InjectTo(edge string, target Module, provider Provider)

Types

type App

type App struct {
	GlobalData map[string]any
	Logger     *Logger
}

func CreateApp

func CreateApp() *App

func (*App) Start

func (a *App) Start(port string) error

type Logger

type Logger struct {
	Target string
}

func CreateLogger

func CreateLogger(target string) *Logger

func (*Logger) Debug

func (l *Logger) Debug(msg string)

func (*Logger) Error

func (l *Logger) Error(msg string)

func (*Logger) Fatal

func (l *Logger) Fatal(msg string)

func (*Logger) Info

func (l *Logger) Info(msg string)

func (*Logger) Warn

func (l *Logger) Warn(msg string)

type Module

type Module struct {
	Name string
	// contains filtered or unexported fields
}

func (*Module) GetInject

func (m *Module) GetInject(edge string) any

func (*Module) GetProvide

func (m *Module) GetProvide() any

func (*Module) Inject

func (m *Module) Inject(edge string, provider Provider)

func (*Module) Provide

func (m *Module) Provide(value any)

type Provider

type Provider interface {
	GetProvide() any
}