URL Shortener - Django REST Framework

Introduction

Welcome to the URL Shortener!

This implement a simple URL shortener API using Django and Django REST Framework (DRF). This application allows users to submit a long URL and receive a shortened URL. When a user accesses the short URL, they should be redirected to the original URL.

---

Scenario

Imagine you're building a miniature version of bit.ly or TinyURL. Users should be able to:

1. Submit a long URL via an API endpoint and receive a shortened version.
2. Use the short URL to be redirected to the original long URL.
3. (Bonus) View basic statistics about the shortened URL (e.g., number of times accessed).

---

Requirements

You need to implement the following features:

• Shorten a URL: Accept a long URL via an API endpoint and return a unique short URL.
• Redirect to Original URL: When a user visits the short URL, they should be redirected to the original long URL.
• Validation: Ensure the input is a valid URL.
• Database Storage: Store the original and shortened URLs in SQLite.
• API Implementation: Use Django REST Framework (DRF) to expose the necessary endpoints.
• Code Structure & Best Practices: Follow Django’s best practices for project structure, error handling, and API design.

Bonus (Optional)

• Track the number of times a short URL has been accessed.
• Implement rate limiting to prevent abuse.
• Allow users to specify a custom short URL (e.g., https://yourshortener.com/mycustomlink).

---

Project Setup & Installation

1. Clone the Repository

git clone https://github.com/your-org/url-shortener.git
cd url-shortener

2. Create & Activate a Virtual Environment

python -m venv venv
source venv/bin/activate  # On macOS/Linux
venv\Scripts\activate     # On Windows

3. Install the Requirements

pip install -r requirements.txt

4. Apply Migrations & Start the Server

python manage.py migrate
python manage.py runserver

5. API Endpoints

Method	Endpoint	Description
POST	/api/shorten/	Submit a long URL and receive a short URL.
GET	/short/<short_code>/	Redirect to the original long URL.
(Bonus) GET	/api/stats/<short_code>/	Retrieve stats for a short URL (e.g., access count).

Screenshots:

• Using Makefile commands

• Generate short URL

• Generate short URL with custom code

• Redirect to URL

• Get stats

• GitHub Actions run tests on PR Open (Tested on a personal private repo)

• GitHub Actions run tests on PR merge to main (Tested on a personal private repo)

• Workflow Status Badge (Screenshot is from a personal private repo)