urupam/README.md

urupam

urupam is a lightweight URL shortener built with Perl and Mojolicious, and backed by Redis.

Requirements

• Perl 5.42.0
• Mojolicious 9.42
• Carton
• Redis

Roadmap

• connect to redis
• create dummy API endpoints
• decide how to handle short url generation
• avoid collisions in short urls
• redirect to the original url
• validate URLs and handle errors
• create a simple and clean UI
• manage/delete short urls
• create installation script
• create systemd service
• create Dockerfile
• create docker-compose.yml
• add unit tests along the way

How to run

To run the application in development, you'll first need a Redis server. The easiest way is to start a local Redis instance using Docker:

docker run --name mojo-redis -p 6379:6379 -d redis

Install Perl dependencies with Carton:

carton install

Start the application with morbo:

carton exec morbo bin/urupam

Open http://127.0.0.1:3000 in your browser.

Installation

Run the installation script:

scripts/install.sh

Enable and start the systemd service:

sudo systemctl enable --now urupam

Using docker

Build the image and use the docker-compose file:

cd docker
docker build -t urupam .
docker compose up -d

License

This project is licensed under the GPLv3+ License. See the LICENSE file for details.