vinyashegde / shorto_url_shorter Goto Github PK

A open source Chrome Extension which shortens your urls in one click with a QR code!

License: MIT License

JavaScript 21.18% HTML 24.98% CSS 53.84%

browser-extension hacktoberfest hacktoberfest2022 chrome-extension woc woc-iiitkalyani hacktoberfest-accepted hacktoberfest2023 open-source

shorto_url_shorter's Introduction

A open source Chrome Extension which shortens your urls in one click with a QR code!

🔒 Your Privacy is Our Priority - No Unnecessary Permissions or User Tracking with Our

This extension allows users to easily shorten long URLs when browsing the web. Simply click on the extension icon, paste in a long URL, and the extension will generate a shortened version that can be shared more easily. The shortened URL will also redirect to the original URL when clicked. This extension is useful for sharing links on social media or through messaging apps, where space is limited. It can also be used to obscure the original URL for privacy reasons. Overall, this extension offers a convenient way to streamline the process of sharing links online.

🚀 Features

Custom API Key Support

Retrieve Link with Creation History

Automatic URL Shortening

Create, Copy, and Download QR Code

Selected Tab Link Copy Button

Keyboard Shortcuts: Windows: Ctrl+Shift+S Mac: Command+Shift+S

Downloads

💻 Languages and Libraries Used

HTML, JavaScript, CSS
Spectre.css: A lightweight and responsive CSS framework. 🎨
FileSaver.js: A JavaScript library that provides a convenient way to save files on the client side. 💾
qrcode.js: A library for generating QR codes in JavaScript. 📷
t.ly (API): An API for URL shortening. 🌐

🚀 Contributing Guidelines

Welcome to our open-source project! We appreciate all contributions. 🙌 For deailted step by step go to Contributing.md

💡 Submitting Contributions

Check for existing issues or create new ones.
Every change should have an associated issue. 📝
Include screenshots in your pull request and link it to the issue using Closes #issue-number. 🖼️

🛠️ Getting Started

To contribute:

Fork this repository. 🍴
Clone your forked repository to your local machine. 🖥️
Add a reference (remote) to the original repository.
Periodically, update your main branch with changes from the main project. 🔄
Create a new branch for your work. 🌿
Make and commit your changes. ✅
Push your changes to your remote branch. 🚀
Create a pull request with a clear title and description. 📢

Thank you for contributing! 🎉

shorto_url_shorter's People

Contributors

Stargazers

Watchers

shorto_url_shorter's Issues

Add different api's to short the url (Minimum 3)

There should be a option where in the user can choose his preferred shorting url and also add a random button where in the user can randomly generate a short url available.

Update the CSS and Ui

a. Clean and Organized Code:

Ensure that your CSS code is clean, well-organized, and easy to read. Use consistent indentation and spacing.

b. Responsive Design:

Make your website responsive to different screen sizes and devices. Use media queries to adjust layout and styles accordingly.

c. CSS Frameworks:

Consider using CSS frameworks like Bootstrap, Foundation, or Tailwind CSS to speed up development and ensure consistency.

d. CSS Variables:

Use CSS variables (custom properties) for defining reusable values like colors, fonts, and spacing.

e. Modular CSS:

Organize your styles into modular components to make it easier to manage and maintain.

f. Optimize for Performance:

Minimize the use of large images and optimize them for web use. Minify and compress CSS files for faster loading

As this is a open source extension, I would like to add a github star in the extension.
So if any one uses it and if they like it, they can give a star to the repository or contribute to the repository.

Feature - Expire View Count

I think we should have the feature of expiring view count. So the shortened URL should expire after expiring view count limit.
This feature should be optional so if the user does not provide a view count then in that case URL will not expire but if the user provides any value greater than 0 then the URL should expire after that number of views.

I have raised a PR for this feature. Please review and approve. If there are any suggestions please let me know.

Thanks

Add a history for the shortened url

Add a section where in the user's shortened url(past) should be accessible to the user.

style sheets should be well designed

Improve the Style

Extension is not optimized!

Optmize the extension as per need for chromium based browsers

Improve UI of the extension

Submit your design for the extension and then we will choose the design suitable for our project. The design should be minimalist and easy to use. Also changes may require depending on how the design looks

Button to create a QR code for the currently selected tab

It would be pretty convenient. You click a button, and it generates a qr code for the URL of whatever tab you have selected at the moment.
I wouldn't mind implementing it if you assign the issue to me

Open ended ideas

We welcome those who have project ideas for our project. Make a document of your project idea with what your idea is and how will you solve it. Also adding a design would be appreciated. If we found the idea to be necessary and important you may be assigned with the idea.