local env setup

.air.toml

@@ -0,0 +1,51 @@
+root = "."
+testdata_dir = "testdata"
+tmp_dir = "tmp"
+
+[build]
+  args_bin = []
+  bin = "./tmp/niyam"
+  cmd = "go build -o ./tmp/niyam ."
+  delay = 1000
+  exclude_dir = ["assets", "tmp", "vendor", "testdata", ".git", ".idea", ".vscode"]
+  exclude_file = ["README.md", "LICENSE", "CHANGELOG.md", "CONTRIBUTING.md", "Dockerfile", "docker-compose.yml", ".air.toml", ".gitignore", ".dockerignore"]
+  exclude_regex = ["_test.go"]
+  exclude_unchanged = false
+  follow_symlink = false
+  full_bin = ""
+  include_dir = []
+  include_ext = ["go", "tpl", "tmpl", "html"]
+  include_file = []
+  kill_delay = "0s"
+  log = "build-errors.log"
+  poll = false
+  poll_interval = 0
+  post_cmd = []
+  pre_cmd = []
+  rerun = false
+  rerun_delay = 500
+  send_interrupt = false
+  stop_on_error = false
+
+[color]
+  app = ""
+  build = "yellow"
+  main = "magenta"
+  runner = "green"
+  watcher = "cyan"
+
+[log]
+  main_only = false
+  time = false
+
+[misc]
+  clean_on_exit = false
+
+[proxy]
+  app_port = 0
+  enabled = false
+  proxy_port = 0
+
+[screen]
+  clear_on_rebuild = false
+  keep_scroll = true

Dockerfile.dev

@@ -0,0 +1,36 @@
+# Dockerfile (modified for development with 'air')
+
+# Stage 1: Builder
+FROM golang:1.24.2-alpine AS builder
+
+# Set the working directory inside the builder container
+WORKDIR /app
+
+# Enable Go modules and disable CGO for a statically linked binary.
+ENV GO111MODULE=on \
+    CGO_ENABLED=0
+
+# Install 'air' for live reloading (only needed in dev)
+# Make sure to install it before copying all source code if you want to cache this layer.
+RUN go install github.com/air-verse/air@latest
+
+# Copy go.mod and go.sum to leverage Docker's build cache.
+COPY go.mod go.sum ./
+
+# Download Go module dependencies
+RUN go mod download
+
+# We will NOT build here for development, as 'air' will handle it.
+# COPY . .
+# RUN go build -o /app/niyam -ldflags "-s -w" ./main.go
+
+# ---
+
+# Stage 2: Runner (This stage is primarily for production builds.
+# For development, Docker Compose will use the 'builder' stage for live reloading directly.)
+FROM scratch
+
+WORKDIR /app
+COPY --from=builder /app/niyam .
+EXPOSE 8080
+CMD ["./niyam"]

README.md

@@ -1,5 +1,5 @@
 ---
-title: GoAPI
+title: NiyamAPI
 emoji: 🦀
 colorFrom: blue
 colorTo: pink
@@ -10,3 +10,10 @@ pinned: false
 # niyamAPI
 
 System for the Niyam project.
+https://axyut-niyamapi.hf.space/docs
+
+# Run Locally
+
+```bash
+docker compose up --build
+```

docker-compose.yml

@@ -0,0 +1,20 @@
+# docker-compose.yml
+version: "3.8"
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile.dev # Refers to your main Dockerfile
+      target: builder # IMPORTANT: Build only the 'builder' stage for dev
+    ports:
+      - "7860:7860" # Map host port 8080 to container port 8080
+    volumes:
+      - .:/app # Mount your current host directory into /app inside the container
+    environment:
+      # Any environment variables your app needs for dev
+      - PORT=7860
+    command: air # Run the 'air' command, which watches files and rebuilds
+    # Optional: If you need to specify the main Go file path for air,
+    # you might need an .air.toml config file, or adjust the command.
+    # By default, air looks for main.go in the current directory or cmd/.

main.go

@@ -40,7 +40,7 @@ func main() {
 	// }
 
 	addr := fmt.Sprintf(":%s", port) // Listen on all interfaces
-	fmt.Printf("Server starting on http://localhost%s...\n", addr)
+	fmt.Printf("Server starting on http://localhost%s/docs\n", addr)
 	err := http.ListenAndServe(addr, router) // <--- THIS IS KEY
 	if err != nil {
 		fmt.Printf("Server failed to start: %v\n", err)