Giter Site home page Giter Site logo

cydrobolt / polr Goto Github PK

View Code? Open in Web Editor NEW
4.9K 139.0 895.0 23.79 MB

:aerial_tramway: A modern, powerful, and robust URL shortener

Home Page: https://polrproject.org

License: GNU General Public License v2.0

PHP 54.67% CSS 6.00% JavaScript 12.19% Shell 0.05% HTML 1.16% Python 0.60% Blade 25.32%
php url-shortener modern laravel api analytics angular json json-api javascript

polr's Introduction

Polr Logo

๐Ÿšก A modern, minimalist, and lightweight URL shortener.

GitHub license GitHub release Builds status Docs

Polr is an intrepid, self-hostable open-source link shortening web application with a robust API. It allows you to host your own URL shortener, to brand your URLs, and to gain control over your data. Polr is especially easy to use, and provides a modern, themable feel.

Getting Started - API Documentation - Contributing - Bugs - IRC

Quickstart

Polr is written in PHP and Lumen, using MySQL as its primary database.

  • To get started with Polr on your server, check out the installation guide. You can clone this repository, or download a release.
  • To get started with the Polr API, check out the API guide.

Installation TL;DR: clone or download this repository, set document root to public/, create MySQL database, go to yoursite.com/setup and follow instructions.

Demo

To test out the demo, head to demo.polr.me and use the following credentials:

  • Username: demo-admin
  • Password: demo-admin

Upgrading Polr

Upgrading from 1.x:

There are breaking changes between 2.x and 1.x; it is not yet possible to automatically upgrade to 2.x.

Upgrading from 2.x:

  • Back up your database and files
  • Update by using git pull or downloading a release
  • Run composer install --no-dev -o to ensure dependencies are up to date
  • Migrate with php artisan migrate to ensure database structure is up to date

Browser Extensions

Libraries

Acknowledgements

We would like to thank Oregon State University's Open Source Lab for providing resources for our infrastructure. The Polr website and demo are hosted on their infrastructure.

Thank you to lastspark for providing our logo's icon.

Versioning

Polr uses Semantic Versioning

License

Copyright (C) 2013-2018 Chaoyi Zha

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

polr's People

Contributors

an-empty-string avatar ashazar avatar azman0101 avatar castanley avatar cjmaxik avatar cydrobolt avatar dignissimus avatar dt27 avatar ekes avatar faktor73 avatar fauskanger avatar ffflorian avatar gradymcd avatar gurgeng avatar iurisilvio avatar jcalonso avatar mattlt avatar mdsalih avatar mihawk90 avatar mik-laj avatar ntoenk1186 avatar oittaa avatar overint avatar peterlewis avatar sc0rp10 avatar sckasturi avatar skorotkiewicz avatar sndrr avatar tdtgit avatar umpc avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

polr's Issues

todo: settings

Issue created by Cydrobolt!Cydrobolt@fedora/cydrobolt

Setup for normal SMTP for every email needs

Dear team:

Is there a way to setup a normal SMTP / phpmailer / Gmail to use instead of sendgrid, so you are more open to any service provider?

Thanks in advance
Kudos for your app, it's awesome.

How to get the key once gone ?

Hello,
I've created a shortened address but it was finished by a key.
Once gone to the site, it's impossible to retrieve the characters after the question mark,
more, I can't delete my link so I can't reuse it without a key...

Would it be possible to mak some evolution on these topics ?
Thank you in advance

create a logo for polr

preferably a silhouette for the navbar logo, and a rectangular logo to replace "polr" in the middle of the page. we might also try ascii art for the main logo

blah

Issue created by skasturi!srijayk@trivialand/developer/wikia.TechFilmer

Not saving to DB; nginx configuration

Hello, once I shorten a url it does not get saved or forwarded. My urls only got do url:/1 and never increments. Accessing the url:/1 gives me a 404. This is certainly an issue and no errors have shown? Where to look?

Thanks!

temp url mode, temp-only keys

Due to some services (e.g arjuanabot) creating masses of shortened URLs, most of which do not need to be kept for very long, I think we need a "temp-url" module (additionally, most shortened urls are not needed for very long). We can assign free temp-only URL Api Keys to anyone who wants one, without fearing that normal users will be severely affected by a mass-shortening DoS attack (e.g shortening lots of URLs to make Polrurls longer).

synopsis:

  • Temporary URLs are prefixed with t- (normal polrurls must be alphanum only)
  • New SQL Table to accommodate tempurls
  • Create tempurls api keys
  • Normal users can choose permanent (default), or temp (optional)
  • More stuff

add ui back

Issue created by Cydrobolt!Cydrobolt@fedora/cydrobolt

Localization

Hi again:

Could you add localization using mo/po, so we can modify it into our native languages. I can help with the spanish translation!

Regards

hi skasturi

Issue created by nyuszika7h!nyuszika7h@pdpc/supporter/active/nyuszika7h

don't use base64

Issue created by skasturi!srijayk@trivialand/developer/wikia.TechFilmer

hi nyuszika7h

Issue created by skasturi!srijayk@april-fools/2014/runnerup/skasturi

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.