Skip to content

landofcash/qrxrq

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub last commit GitHub repo size GitHub issues GitHub pull requests GitHub Stars

🚀 QRXRQ URL Shortener

QRXRQ is an URL shortening service that allows users to shorten and manage links efficiently. It features a React frontend with Tailwind CSS and a Node.js backend with MongoDB and Redis for performance optimization.

Check out the live demo: qrxrq.com

🌟 Features

  • Shorten long URLs with a custom incrementing ID approach
  • Fast redirection with Redis caching
  • User-friendly frontend with dark/light mode
  • REST API for URL management
  • Secure and scalable architecture
  • 404 page is used to redirect to the backend.

🛠 Tech Stack

Frontend

  • React.js with Vite
  • Tailwind CSS v4
  • Vue Router (for routing)
  • ShadCN UI (for UI components)
  • Hosted on GitHub Pages

Backend

  • Node.js with Express
  • MongoDB (Azure Cosmos DB) (primary database)
  • Redis (Azure Cache for Redis) (caching layer)
  • API for URL creation and retrieval
  • Hosted on Azure Linux F1 SKU

🚀 CI/CD

  • Frontend: Automated deployment to GitHub Pages via GitHub Actions
  • Backend: Continuous Deployment to Azure Linux F1 SKU using GitHub Actions

📌 Getting Started

✅ Prerequisites

Ensure you have the following installed:

  • Node.js (v16+)
  • MongoDB
  • Redis
  • Git

📥 Installation

🔽 Clone the repository

git clone https://github.com/landofcash/qrxrq.git
cd qrxrq

🏗 Backend Setup

cd qrxrq-backend
npm install
cp .env.example .env  # Configure your environment variables
npm run dev

🎨 Frontend Setup

cd qrxrq-frontend
npm install
npm run dev

📡 API Endpoints

Method Endpoint Description
POST /api/shorten Shorten a URL
GET /:shortId Redirect to the original URL

🚢 Deployment

You can deploy the frontend and backend separately:

  • Frontend: GitHub Pages (automated via CI/CD)
  • Backend: Azure Linux F1 SKU (automated via CI/CD)

📜 License

This project is POC, licensed under the MIT License.

About

URL Shortener React frontend

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published