Merge pull request #3 from KunalKumar-1/makefile

feat: added makefile

Author: KunalKumar-1

.air.toml

@@ -28,7 +28,7 @@ tmp_dir = "tmp"
   stop_on_error = false
 
 [color]
-  app = ""
+  app = "cyan"
   build = "yellow"
   main = "magenta"
   runner = "green"

Makefile

@@ -0,0 +1,45 @@
+.PHONY: help install deps migrate up down dev run build clean test
+
+help: ## Show this help message
+	@echo 'Usage: make [target]'
+	@echo ''
+	@echo 'Available targets:'
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "  %-15s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+install: ## Install Go dependencies
+	go mod download
+	go mod tidy
+
+deps: install ## Alias for install
+
+migrate-up: ## Run database migrations
+	@echo "Running migrations..."
+	go run cmd/migrate/main.go up
+
+migrate-down: ## Rollback database migrations
+	@echo "Rolling back migrations..."
+	go run cmd/migrate/main.go down
+
+dev: ## Start development server with Air
+	@echo "Starting development server with Air..."
+	air
+
+run: ## Run the application
+	@echo "Starting application..."
+	go run cmd/api/main.go
+
+build: ## Build the application
+	@echo "Building application..."
+	go build -o bin/api cmd/api/main.go
+
+clean: ## Clean build artifacts
+	@echo "Cleaning..."
+	rm -rf tmp/
+	rm -rf bin/
+	go clean
+
+test: ## Run tests
+	@echo "Running tests..."
+	go test -v ./...
+
+.DEFAULT_GOAL := help

README.md

@@ -0,0 +1,83 @@
+# Evently - Event Management API
+
+A Go-based event management API built with Gin, SQLite, and JWT authentication.
+
+## Prerequisites
+
+- Go 1.24.5 or higher
+- Air (for live reload during development)
+- SQLite3
+
+## Getting Started
+
+### 1. Install Dependencies
+
+```bash
+# Install Go dependencies
+go mod download
+
+# Install Air (optional but recommended for development)
+go install github.com/cosmtrek/air@latest
+```
+
+### 2. Environment Setup
+
+Create a `.env` file in the root directory:
+
+```env
+PORT=8080
+JWT_SECRET=your-secret-key-here
+DATABASE_URL=./data.db
+```
+
+### 3. Run Database Migrations
+
+```bash
+go run cmd/migrate/main.go up
+```
+
+### 4. Run the Application
+
+**Option A: Using Air (Recommended for Development)**
+
+```bash
+air
+```
+
+**Option B: Using Go directly**
+
+```bash
+go run cmd/api/main.go
+```
+
+The API will be available at `http://localhost:8080`
+
+## Project Structure
+
+```
+.
+├── cmd/
+│   ├── api/           # Main API application
+│   └── migrate/       # Database migrations
+├── internals/
+│   ├── database/      # Database models and queries
+│   └── env/           # Environment configuration
+├── server/            # Server configurations
+├── data.db            # SQLite database
+├── .air.toml          # Air configuration
+└── go.mod             # Go modules
+
+```
+
+## API Endpoints
+
+- Authentication endpoints
+- Event management endpoints
+
+## Development
+
+The project uses Air for live reload during development. Any changes to `.go` files will automatically rebuild and restart the server.
+
+## License
+
+MIT