Skip to content

Shortix – your sleek and secure solution to turn long URLs into short, shareable magic! 🎯✨ Fast, customizable, analytics-powered & developer-friendly.

Notifications You must be signed in to change notification settings

SaranHiruthikM/Shortix

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€πŸ”— Shortix - The Ultimate URL Shortener

Welcome to Shortix – your sleek and secure solution to turn long URLs into short, shareable magic! 🎯✨
Fast, customizable, analytics-powered & developer-friendly.

Shortix Banner


🌟 Features

  • ⚑ Instant URL Shortening β€” Convert lengthy URLs into concise links in seconds.
  • ✏️ Custom Aliases β€” Personalize your short URLs with memorable slugs.
  • πŸ“ˆ Click Analytics β€” Track visits, referrers, geolocation, and more.
  • πŸ” Spam Protection β€” Input validation, safe URL checking, and rate limiting.
  • ⏳ Link Expiration β€” Set expiration dates for temporary sharing.
  • πŸ“± Mobile-Friendly UI β€” Fully responsive design for all devices.
  • 🧾 QR Code Generator β€” Instantly create and download QR codes for your links.

πŸ› οΈ Getting Started

πŸ”ƒ Clone the Repository

git clone https://github.com/hirux06/Shortix.git
cd Shortix

πŸ“¦ Install Dependencies

npm install

▢️ Run the Application

npm start

βš™οΈ Make sure to create a .env file with necessary environment variables.


πŸ” Environment Variables Example

PORT=5000
MONGODB_URI=mongodb+srv://...
BASE_URL=http://localhost:5000

πŸ§ͺ API Endpoints

Method Endpoint Description
POST /create/ Shorten a long URL
GET /:shortCode Redirect to original URL
GET /generateStats Get click stats (optional)

πŸ™Œ Contributing

We ❀️ contributions from the community!

🧭 Guidelines

  1. Fork the repository 🍴
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes πŸ’»
  4. Commit your changes: git commit -m "✨ Added cool feature"
  5. Push to your fork: git push origin feature/your-feature-name
  6. Submit a pull request πŸš€

πŸ”Ž Code of Conduct

  • Be respectful and inclusive.
  • Use clear and concise commit messages.
  • Follow the existing code style and naming conventions.
  • Report bugs and suggest features through GitHub Issues.

Let's build something amazing together! πŸ’«


πŸ“Έ Screenshots

Web App Mobile View
Web Mobile

πŸ‘¨β€πŸ’» Author

Made with πŸ’– by Saran Hiruthik M
GitHub: @hirux06


⭐ If you like it, give it a star!

πŸ‘‰ git commit -m "⭐ Starred Shortix on GitHub"
Your star means a lot. Let's grow this project together! πŸš€


About

Shortix – your sleek and secure solution to turn long URLs into short, shareable magic! 🎯✨ Fast, customizable, analytics-powered & developer-friendly.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages