Shorten Your Url not Your Possibilities 🚀
🔥 Features 📌 Endpoints 🛠️ API Docs 🚀 Getting Started 🤝 Contributing
spoo.me is a free, open-source service for shortening URLs. It offers URL statistics, a free API, and customization options. You can create custom slugs, add password protection, and manage link lifespans.
Custom Slugs- Create custom slugs for your URLs 🎯Emoji Slugs- Use emojis as slugs for your URLs 😃Password Protection- Protect your URLs with a password 🔒Link Max Clicks- Set a maximum number of clicks for your URLs 📈URL Statistics- View detailed statistics for your URLs 📊BOT Tracking- Track bot clicks on your URLs 🤖API- A free and open-sourced API for URL shortening and statistics 🛠️Export Click Data- Export click data as a CSV, JSON, XLSX, or XML file 📤Open Source- spoo.me is open-sourced and free to use 📖Absolutely Free- No hidden costs, no premium plans, no limitations 💸No Registration- No need to register an account to use spoo.me 📝Self Hosting- You can host spoo.me on your own server 🏠
The basic structure for accessing a shortened URL is: https://spoo.me/<short_code>
Example - https://spoo.me/ga
For password-protected URLs, use the same basic structure. This redirects to a password entry page.
Example - https://spoo.me/exa
Password - Example@12
Tip
Bypass the password entry page by appending the password to the URL parameters - https://spoo.me/<short_code>?password=<password>
To view the statistics for a URL, use the following structure: https://spoo.me/stats/<short_code>
Example - https://spoo.me/stats/ga
Note
You won't be able to view statistics for a password-protected page unless you provide its password.
Spoo.me offers a free, open-source API for URL shortening and statistics. Check it out below:
| spoo.me API |
|---|
To self-host spoo.me on your server, follow the this detailed guide:
| Self-Hosting Guide 🏠 |
|---|
Expand this for a Quick Start
- Docker 🐳
git clone https://github.com/spoo-me/url-shortener.gitmv .env.example .envMONGODB_URI=<your_MONGODB_URI>
CONTACT_WEBHOOK=<valid_webhook_URI>
URL_REPORT_WEBHOOK=<valid_webhook_URI>[!NOTE] With this method, you can either use a cloud service like MongoDB Atlas to store the data remotely or you can use a local MongoDB instance. If you want to use a local MongoDB instance, your MongoDB URI would be
mongodb://localhost:27017/.
docker-compose up- MongoDB 🌿
- MongoDB is only required if you want to store the data locally. You can also use a cloud service like MongoDB Atlas to store the data remotely.
- Python 🐍
- PIP 📦
- Virtualenv (Optional) 🌐
git clone https://github.com/spoo-me/url-shortener.gitpython3 -m venv venvsource venv/bin/activatepip install -r requirements.txtmv .env.example .envMONGODB_URI=<your_MONGODB_URI>
CONTACT_WEBHOOK=<valid_webhook_URI>
URL_REPORT_WEBHOOK=<valid_webhook_URI>[!NOTE] If you installed MongoDB locally, your MongoDB URI would be
mongodb://localhost:27017/or if you are using MongoDB Atlas, you can find your MongoDB URI in the Connect tab of your cluster.
python main.pyOpen your browser and go to http://localhost:8000 to access the spoo.me URL shortener.
Contributions are always welcome! 🎉 Here's how you can contribute:
- Bugs are logged using the github issue system. To report a bug, simply open a new issue.
- Follow the contribution guidelines to get started.
- Make a pull request for any feature or bug fix.
Important
For any type of support or queries, feel free to reach out to us at ✉️ [email protected]
Main Page
Result Page
Stats Page
API Page
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
![@sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=64&v=4){kind=small}