murl

A self-hosted, lightweight URL shortening system designed for efficiency and ease of use.

Project Structure

• packages/service/: The backend API handling storage and redirection logic.
• packages/cli-client/: A companion CLI tool for interacting with the service.
• packages/web-client/: A lightweight SolidJS-powered web interface.

Key Technologies

• Bun: Runtime, package manager, and SQLite driver.
• Hono: Fast web framework for the API.
• SolidJS: Reactive UI library for the web client.
• Vite: Next-generation frontend tooling.
• SQLite: Lightweight database for URL mappings.
• Nanoid: Short, unique, and URL-friendly identifiers.
• TypeScript: Type-safe development.

Main Features

• Efficient URL Shortening: Generate 6-character short codes.
• CLI Interaction: Shorten URLs directly from your terminal.
• Web Interface: Simple and fast dashboard to manage URLs.
• Secure API: Protected by Bearer token authentication.
• Fast Redirection: Immediate redirects.
• Configuration Wizard: Easy CLI setup (murl config).

Getting Started

Installation

bun install

Running the Service

cd packages/service
bun dev

Using the CLI

cd packages/cli-client
bun run src/index.ts <url>

Running the Web Client

cd packages/web-client
bun dev

---

Built with Bun.

Service Build

using docker

docker build --platform linux/amd64 -t mpholley/murl-service:latest .