Enhance template repository with better documentation and setup guide

- Add template repository section to README.md
- Create TEMPLATE_SETUP.md with detailed setup instructions
- Add .env.example file with all required environment variables
- Update README to mention GitHub Actions instead of Jenkins
- Add quick start guide for template usage
- Include customization options and best practices

Author: MitulShah1

.env.example

@@ -1,33 +1,22 @@
-# ───────────────────────────────────────────────
-# 🌟 Application Configuration
-# ───────────────────────────────────────────────
-SERVER_PORT=8080
-DEBUG=true
-DISABLE_LOGS=false
-LOG_FORMAT=json
-LOG_CALLER=true
-LOG_STACKTRACE=false
-
-# ───────────────────────────────────────────────
-# 🌟 Database Configuration
-# ───────────────────────────────────────────────
-DB_HOST=db
+# Database Configuration
+DB_HOST=localhost
 DB_PORT=3306
-DB_USER=myuser
-DB_PASSWORD=mypassword
+DB_USER=user
+DB_PASSWORD=password
 DB_NAME=mydatabase
 
-# ───────────────────────────────────────────────
-# 🌟 Golang Tools Versions
-# ───────────────────────────────────────────────
-SWAG_VERSION=v1.16.4
-MIGRATE_VERSION=v4.16.2
-LINT_VERSION=v1.59.1
-IMPORTS_VERSION=v0.24.0
-VULN_VERSION=v1.1.3
+# Server Configuration
+SERVER_ADDR=
+SERVER_PORT=8080
 
-# ───────────────────────────────────────────────
-# 🌟 Jaeger Configruation
-# ───────────────────────────────────────────────
+# Jaeger Tracing Configuration
 JAEGER_AGENT_HOST=localhost
 JAEGER_AGENT_PORT=6831
+
+# Optional: Override default values for your specific environment
+# DB_HOST=your-database-host
+# DB_PORT=3306
+# DB_USER=your-database-user
+# DB_PASSWORD=your-database-password
+# DB_NAME=your-database-name
+# SERVER_PORT=8080

README.md

@@ -5,9 +5,13 @@
 [![codecov](https://codecov.io/github/MitulShah1/golang-rest-api-template/graph/badge.svg?token=88JSRODXSS)](https://codecov.io/github/MitulShah1/golang-rest-api-template)
 [![Go Report Card](https://goreportcard.com/badge/github.com/MitulShah1/golang-rest-api-template)](https://goreportcard.com/report/github.com/MitulShah1/golang-rest-api-template)
 
+## 🚀 Template Repository
+
+This is a **template repository** for building production-ready and easily extendible REST APIs using Go. Click the "Use this template" button above to create your own repository based on this template.
+
 ## Overview
 
-This is a template for building production-ready and easily extendible REST API using Go. It follows best practices and includes a standardized project structure with all necessary components for building scalable microservices.
+This template follows best practices and includes a standardized project structure with all necessary components for building scalable microservices.
 
 ## Features
 
@@ -16,7 +20,7 @@ This is a template for building production-ready and easily extendible REST API
 - Configuration management
 - API documentation with Swagger
 - Docker support
-- CI/CD pipeline with Jenkins
+- CI/CD pipeline with GitHub Actions
 - Database migrations
 - End-to-end testing
 - Makefile for common operations
@@ -37,6 +41,36 @@ The main ones are:
 - [otel](https://opentelemetry.io/) for observability
 - [jaeger](https://www.jaegertracing.io/) for distributed tracing
 
+## 🎯 Quick Start (Using Template)
+
+### 1. Create Repository from Template
+Click the **"Use this template"** button at the top of this repository, or use GitHub CLI:
+
+```bash
+gh repo create my-go-api --template MitulShah1/golang-rest-api-template
+```
+
+### 2. Clone Your New Repository
+```bash
+git clone https://github.com/YOUR_USERNAME/my-go-api.git
+cd my-go-api
+```
+
+### 3. Update Project Details
+After creating your repository, update these files:
+- `go.mod` - Update module name
+- `README.md` - Update project name and description
+- `.github/workflows/go.yml` - Update repository references if needed
+- `docker-compose.yml` - Update service names if needed
+
+### 4. Start Development
+```bash
+make help          # See all available commands
+make env           # Create .env file
+make docker_up     # Start with Docker
+make test          # Run tests
+```
+
 ## Project Structure
 
 ```sh
@@ -174,7 +208,7 @@ The project includes:
 
 - Dockerfile for containerization
 - docker-compose.yml for local development
-- Jenkinsfile for CI/CD pipeline
+- GitHub Actions for CI/CD pipeline
 
 ## Contributing
 

TEMPLATE_SETUP.md

@@ -0,0 +1,114 @@
+# Template Setup Guide
+
+This guide helps you set up your new repository after creating it from this template.
+
+## 🚀 Initial Setup
+
+### 1. Update Module Name
+Edit `go.mod` and change the module name:
+```go
+// Change from:
+module github.com/MitulShah1/golang-rest-api-template
+
+// To your module name:
+module github.com/YOUR_USERNAME/YOUR_REPO_NAME
+```
+
+### 2. Update Repository References
+Search and replace these references in your codebase:
+- `github.com/MitulShah1/golang-rest-api-template` → `github.com/YOUR_USERNAME/YOUR_REPO_NAME`
+- `MitulShah1/golang-rest-api-template` → `YOUR_USERNAME/YOUR_REPO_NAME`
+
+### 3. Update README.md
+- Change the project title
+- Update badges to point to your repository
+- Modify the description to match your project
+
+### 4. Update GitHub Actions
+In `.github/workflows/go.yml`, update the repository name in badges if needed.
+
+### 5. Update Docker Configuration
+In `docker-compose.yml`, consider updating service names to match your project.
+
+## 🔧 Customization Options
+
+### Database Configuration
+- Update database connection settings in `config/config.go`
+- Modify migration files in `package/database/migrations/`
+- Update database driver if switching from MySQL
+
+### API Endpoints
+- Modify existing handlers in `internal/handlers/`
+- Add new endpoints following the established pattern
+- Update Swagger documentation for new endpoints
+
+### Middleware
+- Customize middleware in `package/middleware/`
+- Add authentication/authorization as needed
+- Configure CORS settings for your domain
+
+### Environment Variables
+- Update `.env.example` with your specific configuration
+- Add new environment variables as needed
+- Document all required environment variables
+
+## 📝 Best Practices for Template Usage
+
+### 1. Keep the Structure
+- Maintain the established project structure
+- Follow the existing patterns for handlers, services, and repositories
+- Use the provided middleware and utilities
+
+### 2. Testing
+- Write tests for all new functionality
+- Follow the existing test patterns
+- Maintain high test coverage
+
+### 3. Documentation
+- Update Swagger documentation for new endpoints
+- Keep README.md up to date
+- Document any new configuration options
+
+### 4. CI/CD
+- The GitHub Actions workflow is ready to use
+- Update repository secrets as needed
+- Configure deployment targets
+
+## 🎯 Quick Commands
+
+After setup, use these commands to get started:
+
+```bash
+# Install dependencies
+go mod tidy
+
+# Run tests
+make test
+
+# Start development environment
+make docker_up
+
+# Generate API documentation
+make generate_docs
+
+# Build the application
+make build
+```
+
+## 📚 Additional Resources
+
+- [Go Documentation](https://golang.org/doc/)
+- [Gorilla Mux](https://github.com/gorilla/mux)
+- [Swagger Documentation](https://swagger.io/docs/)
+- [Docker Documentation](https://docs.docker.com/)
+
+## 🤝 Support
+
+If you encounter issues with the template:
+1. Check the existing issues in this repository
+2. Create a new issue with detailed information
+3. Consider contributing back improvements
+
+---
+
+**Happy Coding! 🚀**