Go URL Shortner API

A simple Go URL Shortner API using Gin framework for managing resources.

Table of Contents

• Introduction
• Prerequisites
• Getting Started
  • Installation
  • Configuration
• Usage
  • Endpoints
  • Examples
• Contributing
• License

Introduction

This API provides a basic URL Shortner interface for managing URLs. It is built using the Go programming language and the Gin web framework.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Go installed (version 1.21)
• Git installed
• Gin installed (used for routing)
• or Simply enter go mod tidy in console, to install all dependencies.

Getting Started

Installation

1. Clone the repository:

   git clone https://github.com/sameergaikwad222/urlshortner.git
   cd urlshortner

2. Install All Dependencies

   go mod tidy

3. Set Configuration File. (path can be found in .gitignore file) Set Config File name as given in .gitignore and set all values accordingly

4. Build & Run the API

   go run main.go

Contributing

Contributions are welcome! Please fork the repository and create a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.