nyior/clipit

a free web URL shortener with an accompanying browser extension that you can't refuse hahaha

Clipit: A web url shortener with an accompanying browser extension.

shorten your urls for free through our web interface or just install our browser extension

what is clipit ?

Simple! Have you worked with Bitly or Tinyurl before? Clipit does pretty much the same thing and more. It is a web application with an accompanying browser extension that allows you create shorter versions of those overly long smelly urls :) you want to share with other people. You know what? Clipit also comes with a free API that you could easily integrate into your projects ✨

Chrome Extension || Edge Extension

See a quick demo of how the browser extension works HERE

Lol Nyior what's the browser extension for? aren't you over engineering?

No not really! the browser extension would allow you shorten urls easily without having to visit our web platform or many more like it each time you want to create a short url. It makes shortening urls more convenient

If you like this repo, click the ⭐

what can clipit be used for?

Nyior, isn't that what you just explained in the paragraph above? Well yeah, but I want to be more specific. Here are the things you could do with clipit.

• you could submit a long URL and get an auto generated shortened version of that url
• as a user, sometimes you'd want to customize the short URL so that you could recall what URL it is referencing or give it a cool name. clipit allows you to do that too. Just submit the long url along with a custom short url you'd want the system to use.
• clipit allows you retrieve a list of all the urls you had shortened in the past
• lastly, shortster also allows you see a report of your short URLs, when it was created, how many times it was clicked, and the last time it was accessed.

Backend Project Setup(backend folder):

• clone project to your local machine
• navigate to the project's backend directory
• Then create a virtual environemnt and install all the project dependencies in the pipfile using the command :

pipenv install

If the command above throws an error, then you most likely do not have pipenv installed. In that case use the command below to install pipenv.

pip install pipenv

Upon completion run the first command again

to run the backend's test cases run the command below in the backend directory(this command should always be ran after the virtual environment has been activated. Refer to the steps above

manage.py test

to spin up the backend's local development server, run the command below(again in the backend directory and after the virtual environment has been activated)

manage.py runserver

Don't know what virtual environments are or how to create virtual environments with pipenv? Don't worry, we got you! learn about python virtual environments and pipenv here

Note that this project was made with Python 3.7.0, other Python versions weren't tested with this project. It is strongly advised that you work with the Python version that was used for this project. Other Python 3 versions too might work tho. Don't have Python 3 installed? Get it here

Frontend Project setup

Navigate into the frontend folder

installs all project dependencies

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Run your tests

npm run test

Lints and fixes files

npm run lint

Chrome Extension Setup(web-extension folder):

• To test if it works, visit chrome://extensions in your browser and ensure that the Developer mode checkbox in the top right-hand corner is checked.

• Click Load unpacked extension and select the directory in which your extension files live(basically, this project's folder). If the extension is valid, it will be active straight away so you can click on the extension's icon in your browser's address bar; this action should trigger a display of a pop up icon.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Website

you could shorten your urls with clipit here

find the documentation for our free API here

License

MIT