{"id":28904797,"url":"https://github.com/SaranHiruthikM/Shortix","last_synced_at":"2025-12-30T22:28:07.099Z","repository":{"id":298324196,"uuid":"999327832","full_name":"hirux06/Shortix","owner":"hirux06","description":"Shortix – your sleek and secure solution to turn long URLs into short, shareable magic! 🎯✨ Fast, customizable, analytics-powered \u0026 developer-friendly.","archived":false,"fork":false,"pushed_at":"2025-06-10T14:17:16.000Z","size":335,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-21T13:02:43.575Z","etag":null,"topics":["nextjs","nodejs","redis","typescript","url-shortener","vercel"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hirux06.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-10T05:06:26.000Z","updated_at":"2025-06-13T03:41:56.000Z","dependencies_parsed_at":"2025-06-10T14:45:55.936Z","dependency_job_id":"1e40ad33-0d92-48da-a217-f51b35505269","html_url":"https://github.com/hirux06/Shortix","commit_stats":null,"previous_names":["hirux06/shortix"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hirux06/Shortix","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hirux06%2FShortix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hirux06%2FShortix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hirux06%2FShortix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hirux06%2FShortix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hirux06","download_url":"https://codeload.github.com/hirux06/Shortix/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hirux06%2FShortix/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261126447,"owners_count":23113312,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nextjs","nodejs","redis","typescript","url-shortener","vercel"],"created_at":"2025-06-21T13:02:24.249Z","updated_at":"2025-12-30T22:28:07.091Z","avatar_url":"https://github.com/hirux06.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# 🚀🔗 Shortix - The Ultimate URL Shortener\n\nWelcome to **Shortix** – your sleek and secure solution to turn long URLs into short, shareable magic! 🎯✨  \nFast, customizable, analytics-powered \u0026 developer-friendly.\n\n![Shortix Banner](image.png)\n\n---\n\n## 🌟 Features\n\n- ⚡ **Instant URL Shortening** — Convert lengthy URLs into concise links in seconds.\n- ✏️ **Custom Aliases** — Personalize your short URLs with memorable slugs.\n- 📈 **Click Analytics** — Track visits, referrers, geolocation, and more.\n- 🔐 **Spam Protection** — Input validation, safe URL checking, and rate limiting.\n- ⏳ **Link Expiration** — Set expiration dates for temporary sharing.\n- 📱 **Mobile-Friendly UI** — Fully responsive design for all devices.\n- 🧾 **QR Code Generator** — Instantly create and download QR codes for your links.\n\n---\n\n## 🛠️ Getting Started\n\n### 🔃 Clone the Repository\n\n```bash\ngit clone https://github.com/hirux06/Shortix.git\ncd Shortix\n```\n\n### 📦 Install Dependencies\n\n```bash\nnpm install\n```\n\n### ▶️ Run the Application\n\n```bash\nnpm start\n```\n\n\u003e ⚙️ Make sure to create a `.env` file with necessary environment variables.\n\n---\n\n## 🔐 Environment Variables Example\n\n```env\nPORT=5000\nMONGODB_URI=mongodb+srv://...\nBASE_URL=http://localhost:5000\n```\n\n---\n\n## 🧪 API Endpoints\n\n| Method | Endpoint             | Description                |\n|--------|----------------------|----------------------------|\n| POST   | `/create/`       | Shorten a long URL         |\n| GET    | `/:shortCode`        | Redirect to original URL   |\n| GET    | `/generateStats` | Get click stats (optional) |\n\n---\n\n## 🙌 Contributing\n\nWe ❤️ contributions from the community!\n\n### 🧭 Guidelines\n\n1. Fork the repository 🍴  \n2. Create a new branch: `git checkout -b feature/your-feature-name`  \n3. Make your changes 💻  \n4. Commit your changes: `git commit -m \"✨ Added cool feature\"`  \n5. Push to your fork: `git push origin feature/your-feature-name`  \n6. Submit a pull request 🚀  \n\n### 🔎 Code of Conduct\n\n- Be respectful and inclusive.\n- Use clear and concise commit messages.\n- Follow the existing code style and naming conventions.\n- Report bugs and suggest features through GitHub Issues.\n\n\u003e Let's build something amazing together! 💫\n\n---\n\n## 📸 Screenshots\n\n| Web App | Mobile View |\n|---------|-------------|\n| ![Web](https://imgur.com/your-web.png) | ![Mobile](https://imgur.com/your-mobile.png) |\n\n---\n\n\n\n## 👨‍💻 Author\n\nMade with 💖 by [Saran Hiruthik M](https://www.linkedin.com/in/saran-hiruthik-m/)  \nGitHub: [@hirux06](https://github.com/hirux06)\n\n---\n\n## ⭐ If you like it, give it a star!\n\n👉 `git commit -m \"⭐ Starred Shortix on GitHub\"`  \nYour star means a lot. Let's grow this project together! 🚀\n\n---\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSaranHiruthikM%2FShortix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSaranHiruthikM%2FShortix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSaranHiruthikM%2FShortix/lists"}