Contributing to URL Shortener

Thank you for considering contributing to our project! Here are some guidelines to help you get started.

Getting Started

Fork the repository: Click the "Fork" button at the top of this page to create a copy of the repository under your GitHub account.
Clone the repository: Use git clone to clone the repository to your local machine.
```
git clone https://github.com/your-username/url-shortner
cd url-shortner
```
Create a branch: Create a new branch for your feature or bug fix.
```
git checkout -b feature-name
```

api/: Contains the main application logic and routes.
- routes.go: Defines the various API routes.
- logic.go: Contains the core business logic for URL shortening and management.
docker/: Contains Docker-related files for containerization.
.env: Environment configuration file.

Below are the primary routes defined in the project:

POST /shorten: Endpoint to create a new shortened URL.
- Request: Expects a JSON body with the original URL, optional custom short URL, and optional expiry time.
- Response: Returns the original URL, the shortened URL, expiry time, remaining rate limit, and rate limit reset time.
- Logic:
  - Parses the request body and validates the URL.
  - Implements rate limiting by checking and updating the user's IP in Redis.
  - Enforces HTTPS and prevents domain errors.
  - Generates a unique short URL or uses the provided custom short URL.
  - Stores the shortened URL in Redis with an expiry time.
  - Returns the response with URL details and rate limit information.
GET /:shortURL: Endpoint to redirect to the original URL.
- Logic:
  - Retrieves the original URL from Redis using the provided short URL.
  - Redirects the user to the original URL.
DELETE /:shortURL: Endpoint to delete a shortened URL.
- Logic:
  - Removes the short URL from Redis.

The core logic includes:

URL Shortening: Generates a unique short code for the provided URL and stores it in Redis.
Redirection: Retrieves the original URL from Redis when a short URL is accessed and redirects the user.
Rate Limiting: Limits the number of URL shortening requests per user within a specified time frame.
HTTPS Enforcement: Ensures all stored URLs are converted to HTTPS.
Domain Error Prevention: Prevents shortening of the service's own domain to avoid infinite loops.
Expiration Management: Manages the expiry of shortened URLs based on user-defined or default criteria.

Commit your changes: Use descriptive commit messages to explain what you have done.
```
git commit -m "Add feature X"
```
Push to your branch: Push your changes to your forked repository.
```
git push origin feature-name
```
Create a Pull Request: Navigate to the original repository and create a pull request from your forked repository.

Please adhere to the Code of Conduct when contributing to this project.

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing!