https://github.com/SaranHiruthikM/Shortix
Shortix – your sleek and secure solution to turn long URLs into short, shareable magic! 🎯✨ Fast, customizable, analytics-powered & developer-friendly.
https://github.com/SaranHiruthikM/Shortix
nextjs nodejs redis typescript url-shortener vercel
Last synced: 6 months ago
JSON representation
Shortix – your sleek and secure solution to turn long URLs into short, shareable magic! 🎯✨ Fast, customizable, analytics-powered & developer-friendly.
- Host: GitHub
- URL: https://github.com/SaranHiruthikM/Shortix
- Owner: hirux06
- Created: 2025-06-10T05:06:26.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-10T14:17:16.000Z (about 1 year ago)
- Last Synced: 2025-06-21T13:02:43.575Z (about 1 year ago)
- Topics: nextjs, nodejs, redis, typescript, url-shortener, vercel
- Language: TypeScript
- Homepage:
- Size: 327 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀🔗 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.
---
## 🌟 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
```bash
git clone https://github.com/hirux06/Shortix.git
cd Shortix
```
### 📦 Install Dependencies
```bash
npm install
```
### ▶️ Run the Application
```bash
npm start
```
> ⚙️ Make sure to create a `.env` file with necessary environment variables.
---
## 🔐 Environment Variables Example
```env
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 |
|---------|-------------|
|  |  |
---
## 👨💻 Author
Made with 💖 by [Saran Hiruthik M](https://www.linkedin.com/in/saran-hiruthik-m/)
GitHub: [@hirux06](https://github.com/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! 🚀
---