url-shortner

URL Shortner is a simple yet powerful tool to generate short versions of urls to share them conveniently with others. It allows users to update the existing long urls without having to reshare a new short version of url with others. The application has been developed in Python & Angular.

https://github.com/csc510-group-5/url-shortner

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.2%) to scientific vocabulary

Keywords

angular api app git python
Last synced: 4 months ago · JSON representation ·

Repository

URL Shortner is a simple yet powerful tool to generate short versions of urls to share them conveniently with others. It allows users to update the existing long urls without having to reshare a new short version of url with others. The application has been developed in Python & Angular.

Basic Info
Statistics
  • Stars: 3
  • Watchers: 0
  • Forks: 7
  • Open Issues: 20
  • Releases: 2
Topics
angular api app git python
Created over 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

URL-Shortner 🔗

GitHub Release GitHub Tag GitHub forks GitHub stars GitHub contributors GitHub commit activity DOI GitHub license

GitHub issues codecov Build and Push WebApp CodeQL ESLint Generate and Deploy Documentation Test & Coverage

Documentation Badge Documentation Badge APIs

URL-Shortner - Simple URL shortener

Wondering why the Shortner is misspelled? Thats because this project is all about making it short, simple and easy to share. URL-Shortner aims to be the easiest ad-free url shortener that can be used to quickly generate sharable short urls.

  • Ever typed out a long url on your phone only to see that you missed a '/' or misspelled a word?

  • Have you shared multiple URLs with others because you sent an incorrect URL earlier?

  • Had to update the same document every year but with updated URL, wondering if there was a way to keep the URL the same and just redirect to new one every year?

If you answered yes to any of the above questions, then this is going to bring a smile to your face! The URL-Shortner is a simple tool that you can utilize to create short versions of that long urls and share it with others. Additionally, its just a few clicks to update an existing URL if you made a mistake or the URL has changes over time. If you don't need it anymore, simply go ahead and delete that.

URL-Shortner Intro Video

URL-Shortner has APIs developed using python and front-end web application developed using angular.

How to use?

Generate

Go to yoururl.tech/url-shortner

URL-Shortner-HomePage

Enter the long version of the URL you want to generate a short version and click Get short URL. You should see a popup mentioning the short version of URL and an access code. This code can be utilized to update or delete an existing URL.

URL-Generated-Popup

Save the access code, since you won't be able to access it later.

Update

Click on Update Existing URL button. This will take you to the update url page.

URL-Update

Enter the following details:

  1. Short URL stub: This is the last part of the short version of url. Eg: For the URL http://sef22group5.pythonanywhere.com/stub/oe7p1SKtPS, oe7p1SKtPS is the stub.

  2. Access Code: This is the code that was provided to you at the time of creating new short URL.

  3. Updated long URL:: Enter the updated URL for the existing short version of URL.

Click on Update URL and if all fields are correct and validated, the URL should be updated.

Delete

If you no longer need a URL, click on Delete Existing URL button on the home page.

URL-Delete

Enter the access code that was provided to you at the time of creating new short URL. Click on Delete URL, and if the access code is correct, it will successfully delete the URL.


We love our contributors ❤️❤️

Make a pull request to help contribute.

Citation (CITATION.cff)

cff-version: 1.0.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Rohit"
  given-names: "Nair"
- family-names: "Deep"
  given-names: "Mehta"
- family-names: "Aditya"
  given-names: "Khadse"
- family-names: "Anmol"
  given-names: "Lunavat"
- family-names: "Pritesh"
  given-names: "Surana"
title: "URL-Shortner"
version: 1.0.0
doi: 10.5281/zenodo.7145409
date-released: 2022-10-04
url: "https://github.com/CSC510-Group-5/URL-Shortner"

GitHub Events

Total
Last Year

Dependencies

.github/workflows/build.yml actions
  • actions/checkout v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/metadata-action v3 composite
  • docker/setup-buildx-action v1 composite
  • docker/setup-qemu-action v1 composite
.github/workflows/codeql-analysis.yml actions
  • actions/checkout v3 composite
  • github/codeql-action/analyze v2 composite
  • github/codeql-action/autobuild v2 composite
  • github/codeql-action/init v2 composite
.github/workflows/eslint.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v2 composite
.github/workflows/generate-documentation.yml actions
  • Azure/static-web-apps-deploy v1 composite
  • actions/checkout v2 composite
  • actions/setup-python v4 composite
.github/workflows/unit_test.yaml actions
  • actions/checkout v3 composite
  • actions/setup-node v2 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v2 composite
url-shortner-webapp/Dockerfile docker
  • nginx 1.17.1-alpine build
  • node 16-alpine build
url_shortner_server/requirements.txt pypi
  • Django ==3.2.15
  • asgiref ==3.3.4
  • coverage ==6.5.0
  • django-cors-headers *
  • flake8 ==5.0.4
  • pytz ==2021.1
  • sqlparse ==0.4.2
url_shortner_server/shortner/requirement.txt pypi
  • Django ==3.2.1
  • asgiref ==3.3.4
  • django-cors-headers *
  • pytz ==2021.1
  • sqlparse ==0.4.2
url-shortner-webapp/package-lock.json npm
  • 848 dependencies
url-shortner-webapp/package.json npm
  • @angular-devkit/build-angular ^14.2.3 development
  • @angular/cli ~14.2.3 development
  • @angular/compiler-cli ^14.2.0 development
  • @types/jasmine ~4.0.0 development
  • jasmine-core ~4.3.0 development
  • karma ~6.4.0 development
  • karma-chrome-launcher ~3.1.0 development
  • karma-coverage ~2.2.0 development
  • karma-jasmine ~5.1.0 development
  • karma-jasmine-html-reporter ~2.0.0 development
  • typescript ~4.7.2 development
  • @angular/animations ^14.2.0
  • @angular/cdk ^14.2.2
  • @angular/common ^14.2.0
  • @angular/compiler ^14.2.0
  • @angular/core ^14.2.0
  • @angular/forms ^14.2.0
  • @angular/material ^14.2.2
  • @angular/platform-browser ^14.2.0
  • @angular/platform-browser-dynamic ^14.2.0
  • @angular/router ^14.2.0
  • rxjs ~7.5.0
  • tslib ^2.3.0
  • zone.js ~0.11.4
.github/workflows/codecov.yml actions