https://github.com/sd2001/urlspec
https://github.com/sd2001/urlspec
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sd2001/urlspec
- Owner: sd2001
- License: mit
- Created: 2024-11-28T19:03:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-04T15:55:29.000Z (over 1 year ago)
- Last Synced: 2025-04-11T14:49:53.396Z (about 1 year ago)
- Language: Python
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# URLSpec: URL Shortening and Analytics Service
**URLSpec** is a lightweight and efficient tool designed for managing and specifying URL routing patterns, optimized for high-performance web services. Built with **FastAPI**, it supports seamless URL mapping, caching with Redis, and persistence using SQLite. The application is structured to simplify the development and deployment of shortened routing mechanisms.
---
## Core Components
### 1. **Routers**
- Handles the primary URL management logic.
- Provides endpoints for:
- Adding new URL routes.
- Fetching existing routes and redirecting them back
- Analytics for each and every shortened urls
- Includes validation for route specifications to ensure compatibility with FastAPI’s standards.
### 2. **Redis Integration**
- Implements caching for faster retrieval of frequently accessed routes.
- Reduces writer-database load and improves overall performance.
### 3. **Exception Handling**
- Configured for handling invalid URLs and expired urls
- If an URL is expired appropriate mssgs is shown to the user and its cleaned from DB
---
## Setting Up Locally
Follow these steps to set up the project on your local
```
pip install virtualenv
python -m venv env
source env/bin/activate # On Windows use `env\Scripts\activate`
pip install -r requirements.txt
# brew install redis // in case of mac or accoridngly as per ur distro
RUN redis-server
```
To run the app locally
```
# set up sample .env referring from sample.env
python3 main.py
## or you may use nohup to run the process in background as well
```
Using Dockerfile
```
cd src
docker build -t urlspec:v1 .
docker run --env-file {{path to .env}} -it {{container_id}}
```
Head over to http://localhost:port/docs to access the app
## Tech Stack
- **Backend Framework:** [FastAPI](https://fastapi.tiangolo.com/) (Python-based, asynchronous, high-performance web framework)
- **Cache:** [Redis](https://redis.io/) (In-memory key-value store for caching)
- **Database:** SQLite (Lightweight SQL database for persistent storage)
- **Deployment Platform:** AWS (EC2 + API Gateway) (Supports scalable cloud deployment)