Giter Club home page Giter Club logo

urlshortener's Introduction

UrlShortener

forthebadge
Build Status Open Source Love

A Django web app that shortens long urls. User may select from a list of available hosts.

Available Hosts

  • Tinyurl
  • Is.gd
  • Bit.ly
  • Google URL Shortener
  • Rebrand.ly

Pre-reqs

Virtualenv - Install required packages in a virtual enviroment. Not necessary, but recommended.

Installation

  1. virtualenv YOURENVNAME - Create new virtualenv for this project
  2. Navigate to directory containing 'requirements.txt'
  3. pip install -r requirements.txt - Install required packages

Usage

On first usage you'll need to apply database migrations: python manage.py migrate

Otherwise run development server using: python manage.py runserver

Testing

Tests are run using pytest

For more information: pytest

Contributions

Getting Started

  1. Create a fork and then clone your fork of the repo
  2. Follow steps for Installation
  3. Ensure project runs: Usage
  4. Ensure tests pass: Testing
  5. Implement your changes along with tests for your change
  6. Push changes to your fork and submit a pull request

Adding a new host

This project uses the pyshorteners library for url shortening, read their documentation for more information on implementing a new host: pyshorteners

urlshortener's People

Contributors

p53ud0k0d3 avatar agdhruv avatar aggmoulik avatar khvilaboa avatar jaywelborn avatar ketouem avatar kushagra7589 avatar luizferreira avatar mkalantar avatar murilocamargos avatar

Watchers

Danny Crasto avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.