Welcome to Shortix β your sleek and secure solution to turn long URLs into short, shareable magic! π―β¨
Fast, customizable, analytics-powered & developer-friendly.
- β‘ 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.
git clone https://github.com/hirux06/Shortix.git
cd Shortixnpm install
npm start
βοΈ Make sure to create a
.envfile with necessary environment variables.
PORT=5000 MONGODB_URI=mongodb+srv://... BASE_URL=http://localhost:5000
| Method | Endpoint | Description |
|---|---|---|
| POST | /create/ |
Shorten a long URL |
| GET | /:shortCode |
Redirect to original URL |
| GET | /generateStats |
Get click stats (optional) |
We β€οΈ contributions from the community!
- Fork the repository π΄
- Create a new branch:
git checkout -b feature/your-feature-name - Make your changes π»
- Commit your changes:
git commit -m "β¨ Added cool feature" - Push to your fork:
git push origin feature/your-feature-name - Submit a pull request π
- 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! π«
| Web App | Mobile View |
|---|---|
| Web | Mobile |
Made with π by Saran Hiruthik M
GitHub: @hirux06
π git commit -m "β Starred Shortix on GitHub"
Your star means a lot. Let's grow this project together! π