About url-slicer

Easy-to-use lightweight web tool for shortening URLs in a modern and customizable way.

l

Published by

README.md

THIS IS SHUT DOWN

As this was simply a project I was working on for studies, it is now shut down so that it doesn't drain my Heroku credits anymore. There are also tons of security issues and I don't have the time or energy to maintain this anymore. Maybe I'll revisit the concept in the future, but definitely not anytime soon.

URL Slicer 🔪

URL Slicer is an easy-to-use, lightweight web tool for shortening URLs in a modern and customizable way. Slice through the clutter of long URLs and serve your audience with clean, manageable links!

Demo

🌐 Try URL Slicer out!

You can try out URL Slicer at the website. It's totally free and has absolutely no limits!

🚀 Features

🔗 Custom short links
📊 Detailed analytics
🔒 Advanced security options
📱 Mobile-friendly design
🌍 Geo-targeting
🔐 Password protection
🖼️ QR code generation

🛠️ Technologies Used

Backend: Node.js with Express.js
Database: MongoDB with Mongoose
Authentication: Passport.js
Frontend: EJS templating engine
Styling: Custom CSS
Icons: Feather Icons
Email: Nodemailer (with Outlook SMTP)
Geolocation: geoip-lite
QR Code: qrcode

🏗️ Project Structure

url-slicer/
│
├── views/                 # EJS templates
├── public/                # Static assets
│   └── styles.css         # Main stylesheet
├── server.js              # Main application file
├── package.json           # Project dependencies
└── .env                   # Environment variables (not in repo)

🚀 Getting Started

Clone the repository:

git clone https://github.com/LyubomirT/url-slicer.git

Install dependencies:
```
npm install
```

Set up your environment variables in a .env file:

[email protected]
password=your_outlook_password
PORT=3000
SESSION_SECRET=your_session_secret
MongoURI=your_mongodb_connection_string

Start the server:
```
npm start
```
Visit http://localhost:3000 in your browser.

🔐 Security Features

Password hashing with bcrypt
Session management
CSRF protection
Rate limiting for password attempts
Secure password reset mechanism

📊 Analytics

URL Slicer provides detailed analytics for your shortened URLs, including:

Total clicks
Geographical distribution of clicks
Device and browser statistics
Click-through rates over time

🌐 API Endpoints

/shorten: Create a new short URL
/:code: Redirect to the original URL
/stats/:code: Get statistics for a specific URL
/api/analytics: Get overall analytics data

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

📜 License

This project is GPL-3.0 licensed.

👤 Author

Lyubomir Ternavskiy

GitHub: @LyubomirT
Buy Me a Coffee: Support URL Slicer
Discord: @lyubomirt
Email: [email protected]
Server: The Orange Squad

Made with ❤️ by Lyubomir Ternavskiy

url-slicer