Alex/polr
1
0
Fork 0
mirror of https://github.com/cydrobolt/polr.git synced 2024-09-19 15:11:40 +02:00
Code Issues Releases Wiki Activity
683 Commits 10 Branches 32 Tags 26 MiB
PHP 54.7%
Blade 25.3%
JavaScript 12.2%
CSS 6%
HTML 1.2%
Other 0.6%
91478d248d
Go to file
Chaoyi Zha 91478d248d Add link to demo in API doc
2017-01-01 11:52:54 -05:00
.github Rename issue template 2016-08-26 12:13:38 -07:00
app Fix spacing 2016-12-29 14:59:58 -05:00
bootstrap Validate forms and APIs using \Validator to reject invalid data 2016-12-03 15:41:24 -05:00
database API auto key assign, anonymous API #141 #142 2016-02-19 19:13:50 -05:00
docs Add link to demo in API doc 2017-01-01 11:52:54 -05:00
public Fix wrap text 2016-12-29 16:48:57 +11:00
resources Update Bootswatch version 2016-12-17 21:15:08 +10:00
storage 2.0 init commit 2015-11-02 23:13:32 -05:00
tests Add option to redirect 404s and disabled URLs; update setup picture for 2.0.0 stable 2016-09-11 16:01:34 -04:00
util Setup wording changes & new versioning script 2016-08-14 22:50:55 -07:00
.env.setup Bump 2.1.1 patch 2016-12-09 15:47:07 -05:00
.gitignore Do not track vendor dir 2016-10-30 16:55:32 +00:00
.jshintrc delegate button actions to parent & add API active toggle logic 2015-12-12 12:47:20 -05:00
.travis.yml Install dependencies thorugh composer on CI 2016-02-27 16:11:51 -05:00
artisan 2.0 init commit 2015-11-02 23:13:32 -05:00
composer.json Explicitly require ^1.0.6 random_compat 2016-10-02 22:20:26 -04:00
composer.lock Explicitly require ^1.0.6 random_compat 2016-10-02 22:20:26 -04:00
LICENSE Correct bugs for LinkController 2015-11-06 20:25:48 -05:00
mkdocs.yml Add doc structure + add API docs 2015-11-14 12:58:18 -05:00
phpunit.xml Fix unit tests 2016-09-11 16:06:30 -04:00
README.md Update README.md 2016-12-09 07:07:39 -05:00
server.php 2.0 init commit 2015-11-02 23:13:32 -05:00

README.md

Logo

🚡 A modern, minimalist, and lightweight URL shortener.

GitHub license 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

Browser Extensions

####Versioning

Polr uses Semantic Versioning

####License

Copyright (C) 2013-2016 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.