impr adds readme.md adds health check endpoint to '/'

Author: 2k4sm

README.md

@@ -0,0 +1,179 @@
+
+# GRPC-CRUD
+
+A simple user management service built using Golang, ScyllaDB, gRPC and served through HTTP using gRPC-gateway. This service provides a RESTful API interface that proxies HTTP requests to compatible gRPC actions.
+
+
+## Tech Stack
+
+- **Go**: Primary programming language
+- **gRPC**: High-performance RPC framework
+- **gRPC-Gateway**: Proxies HTTP APIs to gRPC
+- **Protocol Buffers**: Interface definition language
+- **ScyllaDB**: Performant NoSQL database
+- **docker**/**docker-compose**: Containerization and environment setup
+- **GitHub Actions**: CI/CD pipeline for auto deployment
+- **Buf**: Protocol buffer compiler and dependency management
+
+
+## Project Structure
+
+```
+.
+├── buf.gen.yaml
+├── buf.lock
+├── buf.yaml
+├── compose.yaml
+├── Dockerfile
+├── go.mod
+├── go.sum
+├── main.go
+├── proto
+│   └── users
+│       ├── users_grpc.pb.go
+│       ├── users.pb.go
+│       ├── users.pb.gw.go
+│       └── users.proto
+├── README.md
+├── src
+│   ├── db
+│   │   └── db.go
+│   ├── models
+│   │   └── User.go
+│   └── services
+│       └── userService.go
+```
+
+
+## Prerequisites
+
+- Go 1.23.0 or later
+- Docker and Docker Compose
+- Buf CLI
+- Git
+
+
+## Setup and Installation
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/2k4sm/grpc-crud.git
+cd grpc-crud
+```
+
+
+### 2. Start ScyllaDB with Docker Compose
+
+#### Set env variables into `.env`.
+```bash
+touch .env
+echo "SDB_URI=localhost" >> .env
+```
+Then run
+```bash
+docker-compose up -d
+```
+
+
+This will start a ScyllaDB instance as defined in the `compose.yaml` file.
+
+### 3. Install Dependencies
+
+```bash
+go mod download
+```
+
+
+### 4. Generate Protocol Buffer Code
+
+```bash
+buf generate
+```
+
+
+### 5. Build and Run the Application
+
+```bash
+go build -o grpc-crud .
+./grpc-crud
+```
+
+Alternatively, you can use:
+
+```bash
+go run main.go
+```
+
+### Deployment to EC2
+
+This is configured for automatic deployment to EC2 using GitHub Actions. When changes are pushed to the main branch, the CI/CD pipeline will:
+
+1. Build the application
+2. Deploy to the EC2 instance
+
+### Deployed URL: https://grpc-crud.2k4sm.tech
+
+## HTTP Endpoints
+- GET /users?email={email}: Get a user by email
+
+  ```bash
+  curl -X GET "http://localhost:8080/[email protected]"
+  ```
+
+  or
+
+  ```bash
+  curl -X GET "http://localhost:8080/users?ph_number=1234567890"
+  ```
+- POST /users: Create a new user
+
+    ```bash
+    curl -X POST http://localhost:8080/users \
+      -H "Content-Type: application/json" \
+      -d '{
+            "first_name": "John",
+            "last_name": "Doe",
+            "gender": "MALE",
+            "dob": "1990-01-01",
+            "ph_number": "1234567890",
+            "email": "[email protected]",
+            "access": "UNBLOCKED"
+          }'
+    ```
+- PUT /users/{email}: Update a user by email
+
+    ```bash
+    curl -X PUT http://localhost:8080/users/[email protected] \
+      -H "Content-Type: application/json" \
+      -d '{
+            "first_name": "John",
+            "last_name": "Doe",
+            "gender": "MALE",
+            "dob": "1990-01-01",
+            "ph_number": "0987654321",
+            "email": "[email protected]",
+          }'
+    ```
+- PATCH /users/{curr_email}: Update a user's email or phone number
+
+  ```bash
+  curl -X PATCH http://localhost:8080/users/[email protected] \
+    -H "Content-Type: application/json" \
+    -d '{
+          "new_email": "[email protected]",
+          "new_ph_number": "1122334455"
+        }'
+  ```
+- POST /users/{email}/block: Block a user
+
+  ```bash
+  curl -X POST http://localhost:8080/users/[email protected]/block
+  ```
+- POST /users/{email}/unblock: Unblock a user
+
+  ```bash
+  curl -X POST http://localhost:8080/users/[email protected]/unblock
+  ```
+
+# Thank You for trying out grpc-crud.

main.go

@@ -2,9 +2,11 @@ package main
 
 import (
 	"context"
+	"encoding/json"
 	"log"
 	"net"
 	"net/http"
+	"time"
 
 	"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
 	"github.com/joho/godotenv"
@@ -49,6 +51,23 @@ func main() {
 	}
 
 	mux := runtime.NewServeMux()
+	mux.HandlePath("GET", "/", func(w http.ResponseWriter, r *http.Request, _ map[string]string) {
+		w.Header().Set("Content-Type", "application/json")
+		w.WriteHeader(http.StatusOK)
+
+		response := struct {
+			Time    string `json:"time"`
+			Message string `json:"message"`
+		}{
+			Time:    time.Now().Format(time.RFC3339),
+			Message: "healthy",
+		}
+
+		if err := json.NewEncoder(w).Encode(response); err != nil {
+			http.Error(w, "Failed to encode response", http.StatusInternalServerError)
+		}
+	})
+
 	err = userspb.RegisterUsersHandler(context.Background(), mux, conn)
 	if err != nil {
 		log.Fatalln("Failed to register gateway:", err)