Goe - Modern Go Application Framework 🐹

Goe is a modern Go application framework that combines best practices from leading frameworks and libraries. Built entirely on Uber's Fx dependency injection framework and leveraging GoFiber for its HTTP layer, Goe prioritizes developer experience, modularity, extensibility, and concurrent safety.

It aims to provide a solid foundation for building robust and scalable Go applications with ease. 😊

✨ Core Features

• 🔌 Powerful Dependency Injection: Built on Uber's Fx for type-safe management of application components and lifecycle.
• 🌐 High-Performance HTTP Server: Integrated with GoFiber v3, featuring automatic request logging, middleware support, and fast routing.
• 📝 Structured & Flexible Logging: Utilizes Uber's Zap logger with developer-friendly console output and production-ready JSON formatting.
• ⚙️ Environment-Aware Configuration: Load configuration from environment variables and .env files, with type-safe accessors.
• 💾 Versatile Cache Support: Unified caching interface via Fiber's storage, supporting Memory and Redis drivers.
• 🧩 Extensible Module System: Organize your application into logical modules with managed lifecycles (OnStart, OnStop).
• 🛡️ Contract-Driven Design: Core components are defined by interfaces, promoting loose coupling and testability.
• 🎯 Intuitive Developer Experience: Offers both simple global accessors for convenience and full support for explicit dependency injection.
• 🔄 Concurrency Safety: Core framework components are designed to be safe for concurrent use.
• 🗄️ GORM Database Integration: Seamless integration with GORM for database operations, supporting multiple SQL drivers.
• 🔄 Event System: Built-in event system with Redis backend for publish-subscribe patterns and asynchronous processing.

🚀 Getting Started

Install the dependency:

go get go.oease.dev/goe/v2

Create a minimal application (main.go):

package main

import (
	"github.com/gofiber/fiber/v3"
	"go.oease.dev/goe/v2"
	"go.oease.dev/goe/v2/contract"
)

func main() {
	// Initialize Goe with HTTP module enabled
	_ = goe.New(goe.Options{
		WithHTTP: true,
		Invokers: []any{ // Use Fx invoker to register routes
			func(httpKernel contract.HTTPKernel, logger contract.Logger) {
				app := httpKernel.App()
				app.Get("/", func(c fiber.Ctx) error {
					logger.Info("Hello endpoint was hit!")
					return c.SendString("Hello, World from Goe! 👋")
				})
				logger.Info("Main route registered.")
			},
		},
	})

	// Start the application (blocks until shutdown)
	goe.Run()
}

Access your application at http://localhost:8080.

For a detailed step-by-step guide, please see our full Getting Started documentation.

📖 Comprehensive Documentation

Our comprehensive developer documentation is now available as a beautiful VitePress site:

🌐 https://oeasenet.github.io/goe/

The documentation covers:

• Guide: Step-by-step tutorials from installation to deployment
• Examples: Practical, runnable code examples
• Reference: API documentation and module references
• Event System: Guide to the built-in event system with Redis backend (Event System Guide)

You can also browse the documentation locally by running:

cd docs
bun run docs:dev

🤝 Contributing

Contributions are welcome and greatly appreciated! Please see the Contributing Guide for details on how to get started, including setting up your environment, running tests (make test), and submitting pull requests.

📝 License

Goe is released under the MIT License.