README
¶
GoFr
GoFr is an opinionated microservice development framework. Listed in CNCF Landscape.
Visit https://gofr.dev for more details and documentation.
🎯 Goal
Even though generic applications can be written using GoFr, our main focus is to simplify the development of microservices. We will focus ourselves towards deployment in Kubernetes and aspire to provide out-of-the-box observability.
💡 Advantages/Features
- Simple API syntax
- REST Standards by default
- Configuration management
- Inbuilt Middlewares
- gRPC support
- HTTP service with support for Circuit Breaker and Health Check
👍 Contribute
If you want to say thank you and/or support the active development of GoFr:
- Add a GitHub Star to the project.
- Write a review or tutorial on Medium, Dev.to or personal blog.
- Visit CONTRIBUTING for details on submitting patches and the contribution workflow. After your PR is merged to the repo, fill the google form, and we will send you a GoFr T-Shirt and Stickers as a token of appreciation.
Directories
¶
| Path | Synopsis |
|---|---|
|
cli
|
|
|
gofr
Module
|
|
|
examples
|
|
|
pkg
|
|
|
gofr/container
Package container is a generated GoMock package.
|
Package container is a generated GoMock package. |
|
gofr/datasource/pubsub
Package pubsub provides a foundation for implementing pub/sub clients for various message brokers such as google pub-sub, kafka and MQTT.
|
Package pubsub provides a foundation for implementing pub/sub clients for various message brokers such as google pub-sub, kafka and MQTT. |
|
gofr/datasource/pubsub/google
Package google provides a client for interacting with Google Cloud Pub/Sub.This package facilitates interaction with Google Cloud Pub/Sub, allowing publishing and subscribing to topics, managing subscriptions, and handling messages.
|
Package google provides a client for interacting with Google Cloud Pub/Sub.This package facilitates interaction with Google Cloud Pub/Sub, allowing publishing and subscribing to topics, managing subscriptions, and handling messages. |
|
gofr/datasource/pubsub/kafka
Package kafka provides a client for interacting with Apache Kafka message queues.This package facilitates interaction with Apache Kafka, allowing publishing and subscribing to topics, managing consumer groups, and handling messages.
|
Package kafka provides a client for interacting with Apache Kafka message queues.This package facilitates interaction with Apache Kafka, allowing publishing and subscribing to topics, managing consumer groups, and handling messages. |
|
gofr/datasource/pubsub/mqtt
Package mqtt provides a client for interacting with MQTT message brokers.This package facilitates interaction with MQTT brokers, allowing publishing and subscribing to topics, managing subscriptions, and handling messages.
|
Package mqtt provides a client for interacting with MQTT message brokers.This package facilitates interaction with MQTT brokers, allowing publishing and subscribing to topics, managing subscriptions, and handling messages. |
|
gofr/datasource/redis
Package redis provides a client for interacting with Redis key-value stores.This package allows creating and managing Redis clients, executing Redis commands, and handling connections to Redis databases.
|
Package redis provides a client for interacting with Redis key-value stores.This package allows creating and managing Redis clients, executing Redis commands, and handling connections to Redis databases. |
|
gofr/datasource/sql
Package sql provides functionalities to interact with SQL databases using the database/sql package.This package includes a wrapper around sql.DB and sql.Tx to provide additional features such as query logging, metrics recording, and error handling.
|
Package sql provides functionalities to interact with SQL databases using the database/sql package.This package includes a wrapper around sql.DB and sql.Tx to provide additional features such as query logging, metrics recording, and error handling. |
|
gofr/http
Package http provides a set of utilities for handling HTTP requests and responses within the GoFr framework.
|
Package http provides a set of utilities for handling HTTP requests and responses within the GoFr framework. |
|
gofr/http/middleware
Package middleware provides a collection of middleware functions that handles various aspects of request handling, such as authentication, logging, tracing, and metrics collection.
|
Package middleware provides a collection of middleware functions that handles various aspects of request handling, such as authentication, logging, tracing, and metrics collection. |
|
gofr/logging
Package logging provides logging functionalities for GoFr applications.
|
Package logging provides logging functionalities for GoFr applications. |
|
gofr/metrics
Package metrics provides functionalities for instrumenting GoFr applications with metrics.
|
Package metrics provides functionalities for instrumenting GoFr applications with metrics. |
|
gofr/migration
Package migration is a generated GoMock package.
|
Package migration is a generated GoMock package. |
|
gofr/service
Package service provides an HTTP client with features for logging, metrics, and resilience.It supports various functionalities like health checks, circuit-breaker and various authentication.
|
Package service provides an HTTP client with features for logging, metrics, and resilience.It supports various functionalities like health checks, circuit-breaker and various authentication. |
|
gofr/datasource/cassandra
Module
|
|
|
gofr/datasource/clickhouse
Module
|
|
|
gofr/datasource/dgraph
Module
|
|
|
gofr/datasource/file/ftp
Module
|
|
|
gofr/datasource/file/s3
Module
|
|
|
gofr/datasource/file/sftp
Module
|
|
|
gofr/datasource/mongo
Module
|
|
|
gofr/datasource/pubsub/nats
Module
|
|
|
gofr/datasource/solr
Module
|
Click to show internal directories.
Click to hide internal directories.