Zingzy / spoo.me

spoo.me is a free, ad-free and easy-to-use URL shortener that lets you create short links for any website. You can even choose your own alias, set a password, and limit the number of clicks.

Welcome to spoo.me - Shorten Your Url not Your Possibilities 🚀

Dive into the magic of spoo.me, your shortcut to URL wizardry! 🚀 Transform lengthy links into sleek, memorable ones with our free, open-sourced service. 🌟

What sets us apart? High-level URL stats for insight, free API for developers, and killer customization options! 🎨✨ Craft personalized slugs, add password protection, or control link lifespans. ⏳

Simplify your links, amplify your reach – join spoo.me and make URLs an art form! 🎨🔗

---

📖 Table of Contents

• Welcome to spoo.me - Shorten Your Url not Your Possibilities 🚀
• 📌 Endpoints
  • 🔐 Password Protected URLs
  • 📈 Viewing URL Statistics
• 📊 URL statistics Features
• 🛠️ URL Shortener API
• 🚀 Getting Started
  • 📋 Prerequisites
  • 📂 Clone the repository
  • Creating a virtual environment (Optional)
  • Activate the virtual environment (Optional)
  • 📦 Install dependencies
  • Creating a .env file in the root directory
  • ➕ Adding environment variables to .env file
  • 🚀 Starting the server
• 🤝 Contributing
• 📧 Feedback / Issues / Support
• 👀 Visual Previews

---

📌 Endpoints

Basic Structure: https://spoo.me/<short_code>

Example:

• Short URL: https://spoo.me/ga
  • Redirects to: https://google.com
  • Short code: ga

🔐 Password Protected URLs

Basic Structure: https://spoo.me/<short_code> (redirects to password entry page)

• Productivity Trick: Enter the password like this: https://spoo.me/<short_code>?password=<password>

📈 Viewing URL Statistics

Basic Structure: https://spoo.me/stats/<short_code>

Example:

• URL: https://spoo.me/stats/ga

Note: You cannot view statistics for a password-protected page without providing its password.

📊 URL statistics Features

• Detailed information about the URL, including Date of Creation, Original URL, Total Clicks, etc.
• Graphs displaying URL click history over time, Browser Data, Platforms, Referrers, Countries (Tracks Unique Clicks too)
• In-depth click analysis
• QR Code for the URL

🛠️ URL Shortener API

spoo.me has a free and open-sourced API that allows you to shorten URLs, view URL statistics, and more for your applications, websites, and services.

For detailed API documentation, please visit https://spoo.me/api

🚀 Getting Started

📋 Prerequisites

• MongoDB 🌿
• Python 🐍
• PIP 📦
• Virtualenv (Optional) 🌐

📂 Clone the repository

git clone https://github.com/zingzy/spoo.me.git

Creating a virtual environment (Optional)

python3 -m venv venv

Activate the virtual environment (Optional)

source venv/bin/activate

📦 Install dependencies

pip install -r requirements.txt

Creating a .env file in the root directory

touch .env

➕ Adding environment variables to .env file

MONGO_URI=<your_mongo_uri>

To get your free MongoDB Atlas Cluster, visit https://www.mongodb.com/cloud/atlas

🚀 Starting the server

python main.py

🤝 Contributing

We welcome contributions to spoo.me. Feel free to fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

📧 Feedback / Issues / Support

To give feedback, ask a question or make a feature request, you can either use the Github Discussions

Bugs are logged using the github issue system. To report a bug, simply open a new issue.

For URL deletion requests / any other issues feel free to grill us

👀 Visual Previews

Main Page

Example Stats Page