GoFr

GoFr: An Opinionated Microservice Development Framework

Listed in the CNCF Landscape

GoFr is designed to simplify microservice development, with a key focus on Kubernetes deployment and out-of-the-box observability. While capable of building generic applications, microservices remain at its core.

1. Simple API Syntax
2. REST Standards by Default
3. Configuration Management
4. Observability (Logs, Traces, Metrics)
5. Inbuilt Auth Middleware & Custom Middleware Support
6. gRPC Support
7. HTTP Service with Circuit Breaker Support
8. Pub/Sub
9. Health Check for All Datasources
10. Database Migration
11. Cron Jobs
12. Support for Changing Log Level Without Restarting
13. Swagger Rendering
14. Abstracted File Systems
15. Websockets

• GoFr requires Go version 1.24 or above.

To get started with GoFr, add the following import to your code and use Go’s module support to automatically fetch dependencies:

import "gofr.dev/pkg/gofr"

Alternatively, use the command:

go get -u gofr.dev/pkg/gofr

Here's a simple example to get a GoFr application up and running:

package main

import "gofr.dev/pkg/gofr"

func main() {
	app := gofr.New()

	app.GET("/greet", func(ctx *gofr.Context) (any, error) {
		return "Hello World!", nil
	})

	app.Run() // listens and serves on localhost:8000
}

To run this code:

$ go run main.go

Visit localhost:8000/greet to see the result.

Explore a variety of ready-to-run examples in the GoFr examples directory.

• GoDoc: Official API documentation.
• GoFr Documentation: Comprehensive guides and resources.

Join Us in Making GoFr Better

Share your experience: If you’ve found GoFr helpful, consider writing a review or tutorial on platforms like Medium, Dev.to, or your personal blog. Your insights could help others get started faster!

Contribute to the project: Want to get involved? Check out our CONTRIBUTING.md guide to learn how you can contribute code, suggest improvements, or report issues.

To securely clone the GoFr repository, you can use HTTPS or SSH:

git clone https://github.com/gofr-dev/gofr.git

git clone [email protected]:gofr-dev/gofr.git

If your PR is merged, or if you contribute by writing articles or promoting GoFr, we invite you to fill out this form to claim your GoFr merchandise as a token of our appreciation!