1
0
mirror of https://github.com/cydrobolt/polr.git synced 2024-09-19 23:21:47 +02:00
Go to file
2016-04-16 15:50:07 -04:00
app Implement API rate limitations fix #155 2016-04-01 22:45:29 -04:00
bootstrap Implement core components of registration 2015-11-06 21:44:50 -05:00
database API auto key assign, anonymous API #141 #142 2016-02-19 19:13:50 -05:00
docs Update installation doc with new env name 2016-04-16 15:50:07 -04:00
public Push button hash states to maintain tab on refresh 2016-04-01 21:55:11 -04:00
resources Consolidate functions, add API reset for all users 2016-04-01 21:46:12 -04:00
storage 2.0 init commit 2015-11-02 23:13:32 -05:00
tests Rollback db transactions by test cases 2016-02-19 17:52:16 -05:00
util Abstract URL shortening, create API endpoints & logic 2016-01-29 14:58:49 -05:00
vendor Add vendored files 2016-02-27 16:11:17 -05:00
.codeclimate.yml Exclude minified libs in CodeClimate 2016-04-01 22:05:57 -04:00
.env.setup Rename setup env to .env.setup to avoid conflicts in Git 2016-04-16 15:49:33 -04:00
.gitignore Add vendored files 2016-02-27 16:11:17 -05: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 Add illuminate mailer 2016-02-27 15:54:40 -05:00
composer.lock Add illuminate mailer 2016-02-27 15:54:40 -05:00
CONTRIBUTING.md update contributing guidelines 2016-03-26 11:57:05 -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 2.0 init commit 2015-11-02 23:13:32 -05:00
README.md fix typo 2016-03-15 21:48:20 -04:00
server.php 2.0 init commit 2015-11-02 23:13:32 -05:00
version.sh Add API implementation 2016-02-12 10:38:58 -05:00

Logo

🚡 A modern, minimalist, and lightweight URL shortener.

GitHub license Builds status Docs

Polr is an enterprise-class open-source link shortening web application designed to operate at many scales, built on the Software-as-a-Service paradigm. 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

Upgrading from 1.x

Please do not attempt to upgrade directly to 2.x.

Polr 1.x currently cannot be upgraded to 2.x automatically. There are breaking changes in the API, configuration files, and database structure. A migration will be provided once 2.0 stable is officially released. In the meantime, it is okay to upgrade between different versions in the 1.x arch, which do not have breaking changes.

Quickstart

Polr is written in PHP and Laravel, 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/, MySQL create database, go to yoursite.com/setup ####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.