gofr-dev
diff --git a/‎.github/workflows/typos.yml
Lines changed: 1 addition & 1 deletion b/‎.github/workflows/typos.yml
Lines changed: 1 addition & 1 deletion
diff --git a/‎docs/advanced-guide/startup-hooks/page.md
Lines changed: 59 additions & 0 deletions b/‎docs/advanced-guide/startup-hooks/page.md
Lines changed: 59 additions & 0 deletions
diff --git a/‎docs/navigation.js
Lines changed: 5 additions & 0 deletions b/‎docs/navigation.js
Lines changed: 5 additions & 0 deletions
diff --git a/‎examples/http-server-using-redis/main.go
Lines changed: 21 additions & 0 deletions b/‎examples/http-server-using-redis/main.go
Lines changed: 21 additions & 0 deletions
diff --git a/‎examples/using-add-filestore/go.mod
Lines changed: 13 additions & 13 deletions b/‎examples/using-add-filestore/go.mod
Lines changed: 13 additions & 13 deletions
@@ -11,4 +11,4 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v4
       - name: typos-action
-        uses: crate-ci/typos@v1.34.0
+        uses: crate-ci/typos@v1.35.1
@@ -0,0 +1,59 @@
+# Startup Hooks
+
+GoFr provides a way to run synchronous jobs when your application starts, before any servers begin handling requests. This is useful for tasks like seeding a database, warming up a cache, or performing other critical setup procedures.
+
+## OnStart
+
+You can register a startup hook using the `a.OnStart()` method on your `app` instance.
+
+## Usage
+
+The method accepts a function with the signature:
+
+The method accepts a function with the signature `func(ctx *gofr.Context) error`.
+
+- The `*gofr.Context` passed to the hook is fully initialized and provides access to all dependency-injection-managed services (e.g., `ctx.Container.SQL`, `ctx.Container.Redis`).
+- If any `OnStart` hook returns an error, the application will log the error and refuse to start.
+
+
+### Example: Warming up a Cache
+
+Here is an example of using `OnStart` to set an initial value in a Redis cache when the application starts.
+
+```go
+package main
+
+import (
+    "gofr.dev/pkg/gofr"
+)
+
+func main() {
+    a := gofr.New()
+
+    // Register an OnStart hook to warm up a cache.
+    a.OnStart(func(ctx *gofr.Context) error {
+        ctx.Logger.Info("Warming up the cache...")
+
+        // In a real app, this might come from a database or another service.
+        cacheKey := "initial-data"
+        cacheValue := "This is some data cached at startup."
+
+        err := ctx.Redis.Set(ctx, cacheKey, cacheValue, 0).Err()
+        if err != nil {
+            ctx.Logger.Errorf("Failed to warm up cache: %v", err)
+            return err // Return the error to halt startup if caching fails.
+        }
+
+        ctx.Logger.Info("Cache warmed up successfully!")
+
+        return nil
+    })
+
+    // ... register your routes
+
+    a.Run()
+}
+```
+
+This ensures that critical startup tasks are completed successfully before the application begins accepting traffic.
+
@@ -122,6 +122,11 @@ export const navigation = [
                 href: '/docs/advanced-guide/swagger-documentation',
                 desc: "Learn how to automatically render SwaggerUI documentation for your GoFr APIs, improving discoverability and usability."
             },
+            {
+                title: 'Adding Synchronous Startup Hooks',
+                href: '/docs/advanced-guide/startup-hooks',
+                desc: "Learn how to seed a database, warm up a cache, or perform other critical setup procedures, synchronously before starting your application."
+            },
             {
                 title: 'Error Handling',
                 href: '/docs/advanced-guide/gofr-errors',
 
@@ -17,6 +17,27 @@ func main() {
 	app.POST("/redis", RedisSetHandler)
 	app.GET("/redis-pipeline", RedisPipelineHandler)
 
+	// Register an OnStart hook to warm up a cache.
+	// This runs before route registration as intended.
+	app.OnStart(func(ctx *gofr.Context) error {
+		ctx.Logger.Info("Warming up the cache...")
+
+		// Example: Fetch some data and store it in Redis.
+		// In a real app, this might come from a database or another service.
+		cacheKey := "initial-data"
+		cacheValue := "This is some data cached at startup."
+
+		err := ctx.Redis.Set(ctx, cacheKey, cacheValue, 0).Err()
+		if err != nil {
+			ctx.Logger.Errorf("Failed to warm up cache: %v", err)
+			return err // Return the error to halt startup if caching fails.
+		}
+
+		ctx.Logger.Info("Cache warmed up successfully!")
+
+		return nil
+	})
+
 	// Run the application
 	app.Run()
 }
 
@@ -7,13 +7,13 @@ toolchain go1.24.1
 require (
 	github.com/stretchr/testify v1.10.0
 	go.uber.org/mock v0.5.2
-	gofr.dev v1.42.4
+	gofr.dev v1.42.5
 	gofr.dev/pkg/gofr/datasource/file/ftp v0.2.1
 )
 
 require (
 	cloud.google.com/go v0.120.0 // indirect
-	cloud.google.com/go/auth v0.16.2 // indirect
+	cloud.google.com/go/auth v0.16.3 // indirect
 	cloud.google.com/go/auth/oauth2adapt v0.2.8 // indirect
 	cloud.google.com/go/compute/metadata v0.7.0 // indirect
 	cloud.google.com/go/iam v1.5.2 // indirect
@@ -34,11 +34,11 @@ require (
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-sql-driver/mysql v1.9.3 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
-	github.com/golang-jwt/jwt/v5 v5.2.2 // indirect
+	github.com/golang-jwt/jwt/v5 v5.2.3 // indirect
 	github.com/google/s2a-go v0.1.9 // indirect
 	github.com/google/uuid v1.6.0 // indirect
 	github.com/googleapis/enterprise-certificate-proxy v0.3.6 // indirect
-	github.com/googleapis/gax-go/v2 v2.14.2 // indirect
+	github.com/googleapis/gax-go/v2 v2.15.0 // indirect
 	github.com/gorilla/mux v1.8.1 // indirect
 	github.com/gorilla/websocket v1.5.3 // indirect
 	github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 // indirect
@@ -83,24 +83,24 @@ require (
 	go.opentelemetry.io/otel/sdk/metric v1.37.0 // indirect
 	go.opentelemetry.io/otel/trace v1.37.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.7.0 // indirect
-	golang.org/x/crypto v0.39.0 // indirect
-	golang.org/x/exp v0.0.0-20250408133849-7e4ce0ab07d0 // indirect
-	golang.org/x/net v0.41.0 // indirect
+	golang.org/x/crypto v0.40.0 // indirect
+	golang.org/x/exp v0.0.0-20250620022241-b7579e27df2b // indirect
+	golang.org/x/net v0.42.0 // indirect
 	golang.org/x/oauth2 v0.30.0 // indirect
 	golang.org/x/sync v0.16.0 // indirect
 	golang.org/x/sys v0.34.0 // indirect
 	golang.org/x/term v0.33.0 // indirect
 	golang.org/x/text v0.27.0 // indirect
 	golang.org/x/time v0.12.0 // indirect
-	google.golang.org/api v0.241.0 // indirect
-	google.golang.org/genproto v0.0.0-20250505200425-f936aa4a68b2 // indirect
+	google.golang.org/api v0.243.0 // indirect
+	google.golang.org/genproto v0.0.0-20250603155806-513f23925822 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20250603155806-513f23925822 // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20250603155806-513f23925822 // indirect
-	google.golang.org/grpc v1.73.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20250715232539-7130f93afb79 // indirect
+	google.golang.org/grpc v1.74.2 // indirect
 	google.golang.org/protobuf v1.36.6 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
-	modernc.org/libc v1.65.10 // indirect
+	modernc.org/libc v1.66.3 // indirect
 	modernc.org/mathutil v1.7.1 // indirect
 	modernc.org/memory v1.11.0 // indirect
-	modernc.org/sqlite v1.38.0 // indirect
+	modernc.org/sqlite v1.38.1 // indirect
 )