https://github.com/mumin91/drf-url-shortener-redis
A URL shortener REST API app using Django REST Framework and Redis
https://github.com/mumin91/drf-url-shortener-redis
crc32 django django-rest-framework drf hashids python python-3 redis redis-database url-shortener
Last synced: 4 months ago
JSON representation
A URL shortener REST API app using Django REST Framework and Redis
- Host: GitHub
- URL: https://github.com/mumin91/drf-url-shortener-redis
- Owner: mumin91
- Created: 2022-01-10T18:09:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-02-04T08:03:04.000Z (4 months ago)
- Last Synced: 2026-02-04T20:08:38.591Z (4 months ago)
- Topics: crc32, django, django-rest-framework, drf, hashids, python, python-3, redis, redis-database, url-shortener
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Objective
The project is to implement a URL shortening service using Python/Django. The short URLs are generated using CRC32 and Hashids. The long URL is hashed with CRC32 and hashed with Hashids with salt to generate secured short URL.
### Brief
ShortLink is a URL shortening service where you enter a URL such as https://codesubmit.io/library/react and it returns a short URL such as http://short.est/GeAi9K.
### Description
The project is developed with Docker, docker-compose, Django, Django REST Framework and Redis.
### Prerequisite
For running the project, the following software need to be installed:
- Docker
- docker-compose
### Steps to Run the Project
Please, follow the steps below to run the project:
1. Clone the project
2. Go to the project directory
3. Run `docker-compose up --build` to run the project
4. The project can be accessed through `http://localhost:8000` URL. An example of the full URL would be `http://localhost:8000/encode`.