https://github.com/iamsuvhro/link-shortner
A lightweight URL shortening service built to create short, unique links from long URLs with click tracking. This backend project showcases RESTful API design, threading for concurrent request handling, and database integration, demonstrating scalable and thread-safe web development.
https://github.com/iamsuvhro/link-shortner
fastapi mongdb python3
Last synced: 4 months ago
JSON representation
A lightweight URL shortening service built to create short, unique links from long URLs with click tracking. This backend project showcases RESTful API design, threading for concurrent request handling, and database integration, demonstrating scalable and thread-safe web development.
- Host: GitHub
- URL: https://github.com/iamsuvhro/link-shortner
- Owner: iamsuvhro
- Created: 2025-05-09T17:42:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-10T16:48:11.000Z (about 1 year ago)
- Last Synced: 2025-08-20T21:28:29.478Z (10 months ago)
- Topics: fastapi, mongdb, python3
- Language: Python
- Homepage: https://ishort.onrender.com/
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ©️ ishort (Link Shortner)
A lightweight URL shortening service built to create short, unique links from long URLs with click tracking. This backend project showcases RESTful API design, threading for concurrent request handling, and database integration, demonstrating scalable and thread-safe web development.
Live Demo
🚀 Try the live app at: https://ishort.onrender.com.
## Features
- **URL Shortening**: Generate short links for long URLs.
- **Click Tracking**: Monitor click counts for analytics.
- **RESTful APIs**: Endpoints for creating and redirecting URLs.
- **Thread-Safe**: Handles concurrent requests efficiently.
## Tech Stack
- **Language**: Python
- **Framework**: FastAPI
- **Database**: MongoDB
- **Threading**: Python’s `threading` module
## Setup Instructions
1. **Clone Repository**:
```bash
git clone https://github.com/iamsuvhro/link-shortner.git
cd link-shortner
```
2. **Install Dependencies**:
```bash
pip install -r requirements.txt
```
3. **Run Application**:
```bash
uvicorn main:app --reload
```
4. **Access API**: Visit `http://localhost:8000`.
## Usage
- **Shorten URL**: POST `/shorten` with `{"url": "https://example.com"}`.
- **Redirect**: GET `/{short_code}` to visit the original URL.
- **Analytics**: GET `/analytics/{short_code}` for click data.
## Architecture
- **API Layer**: FastAPI-based REST endpoints.
- **Service Layer**: URL encoding and click tracking logic.
- **Data Layer**: MongoDB for persistent storage.
## Contributing
Fork, create a branch, commit changes, and submit a pull request. Follow the [Code of Conduct](CODE_OF_CONDUCT.md).
## License
MIT License. See [LICENSE](LICENSE).
---
**Built by Suvhro**
🔗 [GitHub](https://github.com/iamsuvhro) | 🔗 [LinkedIn](https://linkedin.com/in/iamsuvhro)
---
**Notes**:
- The README is concise (230 words) and tailored to the provided GitHub repository ([https://github.com/iamsuvhro/link-shortner](https://github.com/iamsuvhro/link-shortner)), which uses FastAPI, MongoDB, and Python.
- The repository lacks a detailed setup guide, so I provided standard FastAPI setup steps. Confirm if additional steps (e.g., database initialization) are needed.
- If you want specific code snippets or adjustments (e.g., adding a screenshot or diagram), please share more details!