En/add readme in examples (#329)

---------

Co-authored-by: Srijan Rastogi <[email protected]>
Co-authored-by: srijan-27 <[email protected]>

Author: Umang01-hash

examples/grpc-server/README.md

@@ -0,0 +1,8 @@
+# GRPC Server Example
+
+This GoFr example demonstrates a simple grpc server.
+
+### To run the example use the command below:
+```console
+go run main.go
+```

examples/http-server-using-redis/README.md

@@ -0,0 +1,15 @@
+# Redis Example
+
+This GoFr example demonstrates the use of redis as datasource through a simple http server.
+
+### To run the example follow the steps below:
+
+- Run the docker image of redis
+```console
+docker run --name gofr-redis -p 2002:6379 -d redis:7.0.5
+```
+
+- Now run the example
+```console
+go run main.go
+```

examples/http-server/README.md

@@ -0,0 +1,22 @@
+# HTTP Server Example
+
+This GoFr example demonstrates a simple http server which supports redis and mysql as datasources.
+
+### To run the example follow the steps below:
+
+- Run the docker image of redis
+```console
+docker run --name gofr-redis -p 2002:6379 -d redis:7.0.5
+```
+
+- Run the docker image of mysql
+```console
+docker run --name gofr-mysql -e MYSQL_ROOT_PASSWORD=password -p 2001:3306 -d mysql:8.0.30
+```
+
+NOTE: Please create a DB named `test` as mentioned in `DB_NAME` using above mysql image.
+
+- Now run the example
+```console
+go run main.go
+```

examples/sample-cmd/README.md

@@ -0,0 +1,8 @@
+# CMD Example
+
+This GoFr example demonstrates a simple CMD application.
+
+### To run the example use the command below:
+```console
+go run main.go
+```

examples/using-custom-metrics/README.md

@@ -0,0 +1,8 @@
+# Custom Metrics Example
+
+This GoFr example demonstrates the use of custom metrics through a simple http server that creates and populate metrics.
+
+### To run the example use the command below:
+```console
+go run main.go
+```

examples/using-http-service/readme.md

@@ -0,0 +1,14 @@
+# Http-Service Example
+
+This GoFr example demonstrates an inter-service http communication along with circuit-breaker as well as 
+service health config addition.
+
+User can use the `AddHTTPService` method to add an http service and then later get it using `GetHTTPService("service-name")`
+
+### To run the example follow the below steps:
+- Make sure your other service and health endpoint is ready and up on the given address.
+- Now run the example using below command :
+
+```console
+go run main.go
+```

examples/using-migrations/readme.md

@@ -0,0 +1,17 @@
+# Migrations Example
+
+This GoFr example demonstrates the use of `migrations` through a simple http server using mysql and redis.
+
+### To run the example follow the below steps:
+- Run the docker image of mysql and redis
+
+```console
+docker run --name gofr-mysql -e MYSQL_ROOT_PASSWORD=password -p 2001:3306 -d mysql:8.0.30
+docker run --name gofr-redis -p 2002:6379 -d redis:7.0.5
+```
+
+- Now run the example using below command :
+
+```console
+go run main.go
+```

examples/using-publisher/readme.md

@@ -0,0 +1,25 @@
+# Publisher Example
+
+This GoFr example demonstrates a simple Publisher that publishes to the given topic when an http request is made to it's
+matching route.
+
+### To run the example follow the below steps:
+
+- Run the docker image of kafka and zookeeper and ensure that your provided topics are created before publishing
+```console
+docker run --rm -d -p 2181:2181 -p 443:2008 -p 2008:2008 -p 2009:2009 \
+    --env ADVERTISED_LISTENERS=PLAINTEXT://localhost:443,INTERNAL://localhost:2009 \
+    --env LISTENERS=PLAINTEXT://0.0.0.0:2008,INTERNAL://0.0.0.0:2009 \
+    --env SECURITY_PROTOCOL_MAP=PLAINTEXT:PLAINTEXT,INTERNAL:PLAINTEXT \
+    --env INTER_BROKER=INTERNAL \
+    --env KAFKA_CREATE_TOPICS="test-topic,test:36:1,krisgeus:12:1:compact" \
+    --name gofr-kafka \
+    krisgeus/docker-kafka
+```
+
+- Now run the example using below command :
+
+```console
+go run main.go
+```
+

examples/using-subscriber/readme.md

@@ -0,0 +1,26 @@
+# Subscriber Example
+
+This GoFr example demonstrates a simple Subscriber that subscribes asynchronously to a given topic and commits based
+on the handler response.
+
+
+### To run the example follow the below steps:
+
+- Run the docker image of kafka and zookeeper and ensure that your provided topics are created before subscribing.
+```console
+docker run --rm -d -p 2181:2181 -p 443:2008 -p 2008:2008 -p 2009:2009 \
+    --env ADVERTISED_LISTENERS=PLAINTEXT://localhost:443,INTERNAL://localhost:2009 \
+    --env LISTENERS=PLAINTEXT://0.0.0.0:2008,INTERNAL://0.0.0.0:2009 \
+    --env SECURITY_PROTOCOL_MAP=PLAINTEXT:PLAINTEXT,INTERNAL:PLAINTEXT \
+    --env INTER_BROKER=INTERNAL \
+    --env KAFKA_CREATE_TOPICS="test-topic,test:36:1,krisgeus:12:1:compact" \
+    --name gofr-kafka \
+    krisgeus/docker-kafka
+```
+
+- Now run the example using below command :
+
+```console
+go run main.go
+```
+