Merge branch 'development' of github.com:gofr-dev/gofr into gofr-guru

README.md

@@ -1,64 +1,75 @@
+<h1 style="text-align: center; font-size: 100px; font-weight: 500;">
+    <i>Go</i>Fr
+</h1>
+
 <p align="center">
 <img align="center" width="300" alt="logo" src="https://github.com/gofr-dev/gofr/assets/44036979/916fe7b1-42fb-4af1-9e0b-4a7a064c243c">
 </p>
-<p align="center"><b>
-GoFr is an opinionated microservice development framework.</b></p>
-
-<div align=center>
-<a href="https://pkg.go.dev/gofr.dev"><img src="https://img.shields.io/badge/%F0%9F%93%9A%20godoc-pkg-00ACD7.svg?color=00ACD7&style=flat-square"></a>
-<a href="https://gofr.dev/docs"><img src="https://img.shields.io/badge/%F0%9F%92%A1%20gofr-docs-00ACD7.svg?style=flat-square"></a>
-<a href="https://codeclimate.com/github/gofr-dev/gofr/maintainability"><img src="https://api.codeclimate.com/v1/badges/58c8d0443a3d08c59c07/maintainability" /></a>
-<a href="https://codeclimate.com/github/gofr-dev/gofr/test_coverage"><img src="https://api.codeclimate.com/v1/badges/58c8d0443a3d08c59c07/test_coverage" /></a>
-<a href="https://goreportcard.com/report/gofr.dev"><img src="https://goreportcard.com/badge/gofr.dev"></a>
-<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg"></a>
-<a href="https://discord.gg/wsaSkQTdgq"><img src="https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat" /></a>
+
+<h2 align="center" style="font-size: 28px;"><b>GoFr: An Opinionated Microservice Development Framework</b></h2>
+
+<div align="center">
+<a href="https://pkg.go.dev/gofr.dev"><img src="https://img.shields.io/badge/GoDoc-Read%20Documentation-blue?style=for-the-badge" alt="godoc"></a>
+<a href="https://gofr.dev/docs"><img src="https://img.shields.io/badge/GoFr-Docs-orange?style=for-the-badge" alt="gofr-docs"></a>
+<a href="https://codeclimate.com/github/gofr-dev/gofr/maintainability"><img src="https://img.shields.io/codeclimate/maintainability/gofr-dev/gofr?style=for-the-badge" alt="maintainability"></a>
+<a href="https://codeclimate.com/github/gofr-dev/gofr/test_coverage"><img src="https://img.shields.io/codeclimate/coverage/gofr-dev/gofr?style=for-the-badge" alt="test-coverage"></a>
+<a href="https://goreportcard.com/report/gofr.dev"><img src="https://goreportcard.com/badge/gofr.dev?style=for-the-badge" alt="Go Report Card"></a>
+<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache_2.0-blue?style=for-the-badge" alt="Apache 2.0 License"></a>
+<a href="https://discord.gg/wsaSkQTdgq"><img src="https://img.shields.io/discord/7289DA?style=for-the-badge&logo=discord&label=Join%20Us%20on%20Discord" alt="discord" /></a>
 <a href="https://gurubase.io/g/gofr"><img src="https://img.shields.io/badge/Gurubase-Ask%20GoFr%20Guru-006BFF" /></a>
 </div>
 
-Listed in [CNCF Landscape](https://landscape.cncf.io/?selected=go-fr).
+<h2 align="center">Listed in the <a href="https://landscape.cncf.io/?selected=go-fr">CNCF Landscape</a></h2>
+
+## 🎯 **Goal**
+GoFr is designed to **simplify microservice development**, with key focuses on **Kubernetes deployment** and **out-of-the-box observability**. While capable of building generic applications, **microservices** remain at its core.
+
+---
 
-## 🎯 Goal
-Even though generic applications can be written using GoFr, our main focus is to simplify the development of microservices.
-We will focus on deployment in Kubernetes and aspire to provide out-of-the-box observability.
+## 💡 **Key Features**
 
-## 💡 Key Features
+1. **Simple API Syntax**
+2. **REST Standards by Default**
+3. **Configuration Management**
+4. **[Observability](https://gofr.dev/docs/quick-start/observability)** (Logs, Traces, Metrics)
+5. **Inbuilt [Auth Middleware](https://gofr.dev/docs/advanced-guide/http-authentication)** & Custom Middleware Support
+6. **[gRPC Support](https://gofr.dev/docs/advanced-guide/grpc)**
+7. **[HTTP Service](https://gofr.dev/docs/advanced-guide/http-communication)** with Circuit Breaker Support
+8. **[Pub/Sub](https://gofr.dev/docs/advanced-guide/using-publisher-subscriber)**
+9. **[Health Check](https://gofr.dev/docs/advanced-guide/monitoring-service-health)** for All Datasources
+10. **[Database Migration](https://gofr.dev/docs/advanced-guide/handling-data-migrations)**
+11. **[Cron Jobs](https://gofr.dev/docs/advanced-guide/using-cron)**
+12. **Support for [Changing Log Level](https://gofr.dev/docs/advanced-guide/remote-log-level-change) Without Restarting**
+13. **[Swagger Rendering](https://gofr.dev/docs/advanced-guide/swagger-documentation)**
+14. **[Abstracted File Systems](https://gofr.dev/docs/advanced-guide/handling-file)**
+15. **[Websockets](https://gofr.dev/docs/advanced-guide/handling-file)**
 
-1. Simple API syntax
-2. REST Standards by default
-3. Configuration management
-4. [Observability](https://gofr.dev/docs/quick-start/observability) (Logs, Traces, Metrics)
-5. Inbuilt [Auth Middleware](https://gofr.dev/docs/advanced-guide/http-authentication) & Support for [Custom Middleware](https://gofr.dev/docs/advanced-guide/middlewares)
-6. [gRPC support](https://gofr.dev/docs/advanced-guide/grpc)
-7. [HTTP service](https://gofr.dev/docs/advanced-guide/http-communication) with support for [Circuit Breaker](https://gofr.dev/docs/advanced-guide/circuit-breaker)
-8. [Pub/Sub](https://gofr.dev/docs/advanced-guide/using-publisher-subscriber)
-9. [Health Check](https://gofr.dev/docs/advanced-guide/monitoring-service-health) by default for all datasources.
-10. [Database Migration](https://gofr.dev/docs/advanced-guide/handling-data-migrations)
-11. [Cron Jobs](https://gofr.dev/docs/advanced-guide/using-cron)
-12. Support for [changing Log Level](https://gofr.dev/docs/advanced-guide/remote-log-level-change) without restarting the application.
-13. [Swagger Rendering](https://gofr.dev/docs/advanced-guide/swagger-documentation)
-14. [Abstracted File Systems](https://gofr.dev/docs/advanced-guide/handling-file)
-15. [Websockets](https://gofr.dev/docs/advanced-guide/handling-file)
+---
 
-![banner.gif](.github/banner.gif)
+## 🚀 **Getting Started**
 
-## Getting started
-### Prerequisites
-GoFr requires [Go](https://go.dev/) version [1.21](https://go.dev/doc/devel/release#go1.21.0) or above.
+### **Prerequisites**
+- GoFr requires **[Go](https://go.dev/)** version **[1.21](https://go.dev/doc/devel/release#go1.21.0)** or above.
 
-### Getting GoFr
-With [Go's module support](https://go.dev/wiki/Modules#how-to-use-modules), `go [build|run|test]` automatically fetches the necessary dependencies when you add the import in your code:
+### **Installation**
+To get started with GoFr, add the following import to your code and use Go’s module support to automatically fetch dependencies:
 
-```sh
+```go
 import "gofr.dev/pkg/gofr"
 ```
 
-Alternatively, use `go get`:
+Alternatively, use the command:
 
-```sh
+```bash
 go get -u gofr.dev/pkg/gofr
 ```
-### Running GoFr
-A basic example:
+
+---
+
+## 🏃 **Running GoFr**
+
+Here's a simple example to get a GoFr application up and running:
+
 ```go
 package main
 
@@ -68,35 +79,46 @@ func main() {
     app := gofr.New()
 
     app.GET("/greet", func(ctx *gofr.Context) (interface{}, error) {
-
         return "Hello World!", nil
     })
 
-   app.Run() // listen and serve on localhost:8000 
+    app.Run() // listens and serves on localhost:8000 
 }
 ```
 
-To run the code, use the `go run` command, like:
+To run this code:
 
-```sh
+```bash
 $ go run main.go
 ```
 
-Then visit [`localhost:8000/greet`](http://localhost:8000/greet) in your browser to see the response!
+Visit [`localhost:8000/greet`](http://localhost:8000/greet) to see the result.
+
+---
+
+## 📂 **More Examples**
+
+Explore a variety of ready-to-run examples in the [GoFr examples directory](https://github.com/gofr-dev/gofr/tree/development/examples).
+
+---
+
+## 👩‍💻 **Documentation**
+
+- **[GoDoc](https://pkg.go.dev/gofr.dev)**: Official API documentation.
+- **[GoFr Documentation](https://gofr.dev/docs)**: Comprehensive guides and resources.
+
+---
 
-### See more examples
-A number of ready-to-run examples demonstrating various use cases of GoFr are available in the [GoFr examples](https://github.com/gofr-dev/gofr/tree/development/examples) directory.
+## 👍 **Contribute**
 
-## 👩‍💻Documentation
-See the  [godocs](https://pkg.go.dev/gofr.dev).
+Help us make GoFr even better:
 
-The documentation is also available on  [gofr.dev](https://gofr.dev/docs).
+1. **Star** this repo on GitHub! 🌟
+2. Write a review or tutorial on **[Medium](https://medium.com/)**, **[Dev.to](https://dev.to/)**, or your blog.
+3. Review the **[CONTRIBUTING.md](CONTRIBUTING.md)** guide to learn how to contribute to the project.
 
-## 👍 Contribute
-If you want to say thank you and/or support the active development of GoFr:
+---
 
-1. [Star](https://docs.github.com/en/get-started/exploring-projects-on-github/saving-repositories-with-stars) the repo.
-2. Write a review or tutorial on [Medium](https://medium.com/), [Dev.to](https://dev.to/) or personal blog.
-3. Visit [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
+### 🎁 **Get a GoFr T-Shirt & Stickers!**
 
-If your PR is merged or you have written an article or contributed in someway to development or spreading the word about GoFr, fill the [Google Form](https://forms.gle/R1Yz7ZzY3U5WWTgy5), and we will send you a <b>GoFr T-Shirt and Stickers</b> as a token of appreciation.
+If your PR is merged, or if you contribute by writing articles or promoting GoFr, we invite you to fill out [this form](https://forms.gle/R1Yz7ZzY3U5WWTgy5) to claim your GoFr merchandise as a token of our appreciation! 

docs/quick-start/connecting-redis/page.md

@@ -12,6 +12,14 @@ Optionally, you can use Docker to set up a development environment as described
 docker run --name gofr-redis -p 6379:6379 -d redis
 ```
 
+You can also set up a development environment with password authentication as described below.
+
+```bash
+docker run --name gofr-redis -p 2002:6379 -d \
+  -e REDIS_PASSWORD=password \
+  redis:7.0.5 --requirepass password
+```
+
 You can set a sample key `greeting` using the following command:
 
 ```bash
@@ -27,13 +35,15 @@ Following configuration keys are required for Redis connectivity:
 
 * `REDIS_HOST`: It specifies the hostname or IP address of your Redis server.
 * `REDIS_PORT`: It specifies the port number on which your Redis server is listening. The default Redis port is 6379.
-
+* `REDIS_USER` : This is the user you'll use to connect to your Redis server. You can configure multiple users with different permissions in a single Redis container. For more details, refer to the [official docs](https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/)
+* `REDIS_PASSWORD`: The password is required only if your Redis server is configured for authentication; if authentication is not enabled, no password is necessary.
 ```dotenv
 APP_NAME=test-service
 HTTP_PORT=9000
 
 REDIS_HOST=localhost
 REDIS_PORT=6379
+REDIS_PASSWORD=password
 ```
 
 The following code snippet demonstrates how to retrieve data from a Redis key named "greeting":

pkg/gofr/datasource/redis/redis.go

@@ -20,6 +20,8 @@ const (
 
 type Config struct {
 	HostName string
+	Username string
+	Password string
 	Port     int
 	Options  *redis.Options
 }
@@ -75,6 +77,10 @@ func getRedisConfig(c config.Config) *Config {
 
 	redisConfig.HostName = c.Get("REDIS_HOST")
 
+	redisConfig.Username = c.Get("REDIS_USER")
+
+	redisConfig.Password = c.Get("REDIS_PASSWORD")
+
 	port, err := strconv.Atoi(c.Get("REDIS_PORT"))
 	if err != nil {
 		port = defaultRedisPort
@@ -88,6 +94,14 @@ func getRedisConfig(c config.Config) *Config {
 		options.Addr = fmt.Sprintf("%s:%d", redisConfig.HostName, redisConfig.Port)
 	}
 
+	if options.Username == "" {
+		options.Username = redisConfig.Username
+	}
+
+	if options.Password == "" {
+		options.Password = redisConfig.Password
+	}
+
 	redisConfig.Options = options
 
 	return redisConfig