README.md
    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.

    项目简介

    🚡 A modern, powerful, and robust URL shortener

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/cydrobolt/polr

    发行版本 23

    2.3.0

    全部发行版

    贡献者 35

    全部贡献者

    开发语言

    • PHP 54.7 %
    • Blade 25.3 %
    • JavaScript 12.2 %
    • CSS 6.0 %
    • HTML 1.2 %