π Welcome to LOL URL
Your Links, Now with Superpowers. π
π Live Demo β’
Issues β’
Pull Requests β’
Contributing β’
Demo Guide β’
Roadmap β’
FAQ
π Shrink links, share smarter, and track your impact. Now open-source β contribute and grow with us!
π Visit lolurl.site Now
LOL URL is a modern and playful open source URL-shortening website that lets you shrink long links, download custom QR codes, and track detailed analytics, including total clicks and regional insights. Built for simplicity and speed, LOL URL is perfect for creators, marketers, businesses, and anyone who loves smart link management. π
β¨ Features
| Feature | Description |
|---|---|
| URL Shortening | Convert long URLs into sleek, shareable links |
| QR Code Generator | Download custom QR codes in high-quality formats |
| Analytics Dashboard | Track total clicks and regional insights |
| Fast & Responsive | Built with modern tools for seamless performance |
| Link Management | Organize and manage all your shortened URLs in one place |
| Custom Aliases | Create custom aliases for your shortened URLs |
| Open Source | 100% MIT licensed (LICENSE) |
| Live Demo | Try it instantly! |
See the ARCHITECTURE.md and GLOSSARY.md for more details.
π Quick Start
Want to try it out? Check the live demo! or see DEMO.md
Local Setup
- Clone the repository:
git clone https://github.com/Rohit-Dnath/LOL-URL.git cd LOL-URL - Install dependencies:
npm install - Set up environment variables:
Create a
.envfile and add the required Supabase credentials and other configurations. See TROUBLESHOOTING.md if you get stuck. - Run the development server:
npm run dev - Open http://localhost:3000 in your browser to view the app.
For deployment, see DEPLOYMENT-GUIDE.md.
π οΈ Usage
- Paste a long URL into the input field
- Click the "Shorten" button to generate a short link
- Download the QR code or copy the link for sharing
- Access analytics to track clicks and regions
- Manage your links and view detailed analytics in the dashboard
See FAQ.md and USAGE.md for more tips.
π€ Contributing
We welcome contributions from everyone! Want to make LOL URL even better?
- Fork the repository
- Create a new branch:
git checkout -b feature/your-feature-name - Make your changes and add tests if applicable
- Run
npm run lintandnpm run buildto ensure code quality - Commit your changes:
git commit -m 'Describe your change' - Push to your fork:
git push origin feature/your-feature-name - Open a pull request with a clear description
Before contributing, please read:
- CONTRIBUTING.md
- CODE_OF_CONDUCT.md
- SECURITY.md
- SUPPORT.md
- TROUBLESHOOTING.md
- GOVERNANCE.md
- CODESTYLE.md
- COMMUNITY-GUIDELINES.md
See CONTRIBUTORS-GUIDE.md for more ways to get involved!
π Acknowledgements
Special thanks to the open-source community for providing the tools and libraries that made this project possible. See THIRD_PARTY_NOTICES.md for a full list of dependencies.
π₯ Contributors
This project exists thanks to all the amazing people who contribute! π
π Project Founder & Lead Maintainer
Rohit Debnath π - Creator & Admin
- π Built LOL URL from the ground up
- π οΈ Lead maintainer and project architect
- π‘ Vision: Making URL shortening fun and accessible for everyone
π How to become a contributor:
- π Report bugs - Found an issue? Open an issue
- π‘ Suggest features - Have ideas? We'd love to hear them!
- π§ Submit pull requests - Code contributions are always welcome
- π Improve documentation - Help make our docs better
- π¨ Design improvements - UI/UX enhancements
- π§ͺ Testing - Help us test new features and report issues
- π’ Spread the word - Share LOL URL with your network
π Getting Started as a Contributor:
- Star the repo β - Show your support!
- Fork the repository - Create your own copy
- Check out CONTRIBUTING.md for detailed guidelines
- Look for good first issues to get started
- Join our community - Connect with other contributors
π Recognition
Every contributor, no matter how big or small their contribution, is valued and recognized:
- Code Contributors - Listed in our contributors graph
- Documentation Contributors - Credited in relevant docs
- Community Contributors - Recognized in our community channels
- Issue Reporters - Acknowledged in issue resolutions
- Feature Suggesters - Credited when features are implemented
Together, we're building something amazing! π
Want to see your name here? Check out our CONTRIBUTORS-GUIDE.md to get started!
π¬ Contact & Support
For any inquiries, support, or suggestions:
- Open an issue for bugs or feature requests
- Email: [email protected]
- Website: rohitdebnath.me
- See SUPPORT.md and SECURITY_CONTACTS.md
π’ Spread the Word
If you love LOL URL, star the repo, share it on social media, and tell your friends! Every β and share helps this project grow and reach more people.
π More Docs
- FAQ.md
- GLOSSARY.md
- ROADMAP.md
- RELEASE-NOTES.md
- AUTHORS.md
- MAINTAINERS.md
- FUNDING.md
- BRANDING-GUIDE.md
- ARCHITECTURE.md
- DEMO.md
- SUPPORTED_PLATFORMS.md
- MIGRATION-GUIDE.md
- TESTING-GUIDE.md
- CONTRIBUTORS-GUIDE.md
- CODESTYLE.md
- GOVERNANCE.md
- THIRD_PARTY_NOTICES.md
- SECURITY_CONTACTS.md
π Docs Folder
| File | Description |
|---|---|
| docs/database.md | Database overview & ER diagram |
| docs/schemas.md | Table schemas (SQL) |
| docs/api.md | API endpoints |
| docs/setup.md | Setup guide |
| docs/architecture-diagram.md | Architecture diagram (Mermaid) |
βοΈ Tech Stack
| Layer | Technology |
|---|---|
| Frontend | React, Vite, Tailwind CSS |
| Backend | Supabase (DB, Auth, Analytics) |
| Deployment | Vercel |
| Docs | Markdown, Mermaid |
Hey, it's me, the developer of LOL URL,
Rohit Debnath
Connect with me:
Made with β€οΈ by the open source community.
Shorten, Share, Track, Laugh! π