feat: add CLI flags to app

- implement command-line flags for listen address and port
- add usage section to README

🤖

README.md

@@ -6,6 +6,10 @@ A pomodoro server written in Go
 
 `go install git.smsvc.net/pomodoro/GoTomato@latest`
 
+## Usage
+
+See `GoTomato --help` for Parameters
+
 ## Testing
 
 ```

cmd/server/main.go

@@ -1,16 +1,31 @@
 package server
 
 import (
+	"flag"
+	"fmt"
 	"git.smsvc.net/pomodoro/GoTomato/internal/websocket"
+	"git.smsvc.net/pomodoro/GoTomato/pkg/models"
 	"log"
 	"net/http"
 )
 
 func Start() {
+	// Define CLI flags for ListenAddress and ListenPort
+	listenAddress := flag.String("listenAddress", "0.0.0.0", "IP address to listen on")
+	listenPort := flag.Int("listenPort", 8080, "Port to listen on")
+	flag.Parse()
+
+	serverConfig := models.GoTomatoServerConfig{
+		ListenAddress: *listenAddress,
+		ListenPort:    *listenPort,
+	}
+
+	listen := fmt.Sprintf("%s:%d", serverConfig.ListenAddress, serverConfig.ListenPort)
+
 	http.HandleFunc("/ws", websocket.HandleConnections)
 
-	log.Println("Pomodoro WebSocket server started on :8080")
+	log.Printf("Pomodoro WebSocket server started on %s\n", listen)
-	err := http.ListenAndServe(":8080", nil)
+	err := http.ListenAndServe(listen, nil)
 	if err != nil {
 		log.Fatalf("Error starting server: %v", err)
 	}

internal/pomodoro/pomodoro.go

@@ -7,12 +7,12 @@ import (
 	"sync"
 )
 
-const (
+var PomodoroConfig = models.GoTomatoTimerConfig{
-	workDuration       = 15 * 60
+	Work:       15 * 60,
-	shortBreakDuration = 5 * 60
+	ShortBreak: 5 * 60,
-	longBreakDuration  = 10 * 60
+	LongBreak:  10 * 60,
-	sessions           = 4
+	Sessions:   4,
-)
+}
 
 var pomodoroRunning bool
 var pomodoroPaused bool
@@ -30,16 +30,16 @@ func RunPomodoroTimer(clients map[*websocket.Conn]*models.Client) {
 	pomodoroPaused = false
 	mu.Unlock()
 
-	for session := 1; session <= sessions; session++ {
+	for session := 1; session <= PomodoroConfig.Sessions; session++ {
-		if !startTimer(clients, workDuration, "Work", session) {
+		if !startTimer(clients, PomodoroConfig.Work, "Work", session) {
 			break
 		}
-		if session == sessions {
+		if session == PomodoroConfig.Sessions {
-			if !startTimer(clients, longBreakDuration, "LongBreak", session) {
+			if !startTimer(clients, PomodoroConfig.LongBreak, "LongBreak", session) {
 				break
 			}
 		} else {
-			if !startTimer(clients, shortBreakDuration, "ShortBreak", session) {
+			if !startTimer(clients, PomodoroConfig.ShortBreak, "ShortBreak", session) {
 				break
 			}
 		}

internal/pomodoro/timer.go

@@ -23,7 +23,7 @@ func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int
 				broadcast.BroadcastMessage(clients, models.BroadcastMessage{
 					Mode:       mode,
 					Session:    session,
-					MaxSession: sessions,
+					MaxSession: PomodoroConfig.Sessions,
 					TimeLeft:   remainingSeconds,
 				})
 				time.Sleep(time.Second)
@@ -36,7 +36,7 @@ func startTimer(clients map[*websocket.Conn]*models.Client, remainingSeconds int
 	broadcast.BroadcastMessage(clients, models.BroadcastMessage{
 		Mode:       mode,
 		Session:    session,
-		MaxSession: sessions,
+		MaxSession: PomodoroConfig.Sessions,
 		TimeLeft:   0,
 	})
 

pkg/models/config.go

@@ -0,0 +1,13 @@
+package models
+
+type GoTomatoTimerConfig struct {
+	Work       int `json:"work"`
+	ShortBreak int `json:"shortBreak"`
+	LongBreak  int `json:"longBreak"`
+	Sessions   int `json:"sessions"`
+}
+
+type GoTomatoServerConfig struct {
+	ListenAddress string `json:"listenAddress, default:"0.0.0.0"`
+	ListenPort    int    `json:"listenPort, default:8080"`
+}