Skip to content
πŸ”— Minimal URL - Modern URL shortener with support for custom alias
Branch: master
Clone or download
Latest commit 4f2e50e Jul 18, 2019

README.md

When I wrote this, only God and I understood what I was doing. Now, only God knows.
Liyas Thomas

Liyas Thomas

Built with ❀︎ by liyasthomas and contributors

Build Status GitHub release repo size license contributions welcome Website Donate

mnmlurl mnmlurl

πŸ”— Minimal URL is a modern URL shortener with support for custom alias by Liyas Thomas


mnmlurl mnmlurl

Features ✨

😍 URL shortning made simple: mnmlurl uses jsonstore.io to store data on an endpoint JSON file using HTTPS requests. It works on any url.

❀️ No server side logging: Your privacy is important for us. We never log, collect or prompt to sell your data to anyone.

πŸ”₯ Custom and random alias support: Add your own custom alias or generate a random one.

πŸ”’ Generate QR code: Create and download shortened URL's QR code.

βš—οΈ Manage URLs: Delete already created alias to update/create new URLs.

⚑️ Performance: mnmlurl is a thin web app on top of HTML, CSS and JavaScript. Being a Progressive web app, mnmlurl offers lightning fast loading and offline support via workbox and service worker.

πŸ’ Browser extension: Get mnmlurl Chrome browser extension

Minimal URL can be hosted on any website hosting services like GitHub/GitLab pages, Firebase/Heroku hosting, yoursite.com, etc. For hosting in such custom domains, Its advised to npm run-scripts build and upload output folder. Hosting on GitHub pages was just for proof of concept.

IMPORTANT: Minimal URL is an experimental project. Don't shorten sensitive contents/URLs with it. jsonstore.io endpoints are always public making shortened URLs visible for everyone.


Demo

mnmlurl.ml (production)

liyasthomas.github.io/mnmlurl/src (development)


Built with

  • HTML - For the web framework
  • CSS - For styling components
  • Chromium - Thanks for being so fast!

Contributing

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.


Continuous Integration

We use Travis CI for continuous integration. Check out our Travis CI Status.


Versioning

This project is developed by Liyas Thomas using the Semantic Versioning specification. For the versions available, see the releases on this repository.


Authors

Lead Developers

Testing and Debugging

Contributors

See also the list of contributors who participated in this project.


License

This project is licensed under the MIT License - see the LICENSE file for details.


Change log

See the CHANGELOG file for details.


Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspirations:
You can’t perform that action at this time.