Skip to content

linkshrtnr/linkshrtnr_api

Repository files navigation

LinkShrtnr 🚀

LinkShrtnr is a sleek, fast, and modern link shortener built with Rust, Axum, SQLx, and HTMX. Shorten your links and share them effortlessly!

Features 🌟

  • Fast and Efficient: Utilizes the power of Rust for high-performance link shortening.
  • User-Friendly Interface: A clean and intuitive UI for effortless link management.
  • Secure: Built with security in mind, ensuring the safety of your data and links.
  • Customizable: Personalize your short URLs and make them unique.

Technologies Used 🛠️

  • Rust: A systems programming language known for its speed and reliability.
  • Axum: A web framework designed for building scalable and asynchronous applications.
  • SQLx: A SQL query builder with runtime support for async/await.
  • HTMX: A modern JavaScript library for high-quality web applications.

Getting Started 🚀

Follow these steps to get LinkShrtnr up and running:

Prerequisites

  • Rust installed
  • PostgreSQL database set up

Installation

  1. Clone the repository:
    git clone https://github.com/ikurotime/linkshrtnr_api.git
    cd linkshrtnr_api
  2. Set up your environment variables:
cp .env.example .env

Fill in the necessary information in the .env file. 3.Run the application

cargo run
  1. Navigate to http://localhost:3000 to view the application.

Features 🌟

  • Fast and Efficient: Utilizes the power of Rust for high-performance link shortening.
  • User-Friendly Interface: A clean and intuitive UI for effortless link management.
  • Secure: Built with security in mind, ensuring the safety of your data and links.
  • Customizable: Personalize your short URLs and make them unique.

Technologies Used 🛠️

  • Rust: A systems programming language known for its speed and reliability.
  • Axum: A web framework designed for building scalable and asynchronous applications.
  • SQLx: A SQL query builder with runtime support for async/await.
  • HTMX: A modern JavaScript library for high-quality web applications.

Contributing 🤝

Contributions are welcome! Feel free to open issues, submit pull requests, or share your ideas.

Enjoy shrinking your links with LinkShrtnr! 🚀