GoFr-SOC: Template Track – URL Shortener

[sksmagr23]

Hello, Gofr team
I will be working on a scalable URL Shortener service offering custom short links and real-time analytics. It will feature clean REST API, user management, and detailed insights into link usage and performance.

PR 1 plan | Week 1

Project setup, Health Check, and Basic URL Shortener Endpoints

Description

• Initialized the GoFr project with a clean three-layer architecture:- handler, service, and store
• Set up the basic project structure and configuration
• Implemented a Health Check Endpoint:
  • GET /health — Verifies service status and MongoDB connectivity
• Developed initial URL Shortener Endpoints (without authentication):
  • POST /api/urls — Accepts an original URL and returns a short code
  • GET /api/urls/{short_code} — Retrieves the original URL for a given short code
  • GET /{short_code} — Redirects to the original URL (HTTP 302)
• Integrated golangci-lint for linting
• Added CI workflow for running tests and lint checks

Deliverables

• GET /health confirms both service and database connectivity
• POST /api/urls and GET /api/urls/{short_code} function correctly for basic create/retrieve operations
• Full unit test coverage for all functionality
• CI pipeline successfully runs tests and passes linting
• Documentation included for project setup and API usage

I'd love to know your thoughts on the plan before I begin , if any changes needed.

[coolwednesday]

Please add @Umang01-hash as an collaborator for PR reviews.

[sksmagr23]

@Umang01-hash shared the invite and added the PR for review
https://github.com/sksmagr23/url-shortener.git

[Umang01-hash]

@sksmagr23 Sure will review in some time.