Alex/polr
1
0
Fork 0
mirror of https://github.com/cydrobolt/polr.git synced 2024-09-20 07:31:53 +02:00
Code Issues Releases Wiki Activity

Merge branch 'master' of github.com:cydrobolt/polr

Browse Source
This commit is contained in:
Chaoyi Zha 2016-04-01 21:46:34 -04:00
commit d6572d3c47
3 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -1 +1,13 @@
We welcome contributions through pull requests on GitHub and encourage contributors to join our IRC channel on freenode, #polr
Polr is written in PHP with the Lumen (Laravel-based) framework. As of 2016, we won't be officially supporting 1.x outside of fixing critical security bugs. The 1.x legacy branch uses MySQLi and requires the MySQL native driver -- whereas 2.x requires the PDO driver and uses the Eloquent ORM.
You can run tests for Polr using `phpunit`, and we encourage all contributors submitting a pull request to run them beforehand.
Polr is licensed under the __GPLv2+__ license: either version 2 of the GPL, or at your option, any later version.
By contributing to Polr, you agree to have your work licensed under GPLv2+.
Please be considerate towards others and respect all who participate in the community.
Thank you so much for contributing!

3
docs/index.md
View File

@ -4,7 +4,4 @@
[![2.0 status](https://img.shields.io/badge/beta-2.0-yellow.svg)](https://github.com/cydrobolt/polr/tree/2.0-dev)
[![GitHub release](https://img.shields.io/badge/stable-1.5.1-blue.svg)](https://github.com/cydrobolt/polr/releases)
Welcome to Polr's 2.0 development branch.
Please keep in mind 2.0 is pre-alpha, and should not be used in production.
Polr is a beautiful, modern, lightweight, and minimalist open-source URL shortening application. 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 interface.

5
docs/user-guide/installation.md
View File

@ -9,6 +9,8 @@ The following software is required on your server to run Polr 2.0.
In the case that you cannot fulfill the following requirements (e.g free shared hosting),
you may be interested in looking at a [legacy 1.x release](https://github.com/cydrobolt/polr/releases) of Polr (now unsupported).
If you would like to download a stable version of Polr, you may check out [the releases page](https://github.com/cydrobolt/polr/releases).
- Apache, nginx, IIS, or lighttpd (Apache preferred)
- PHP >= 5.5.9
- MariaDB or MySQL >= 5.5, SQLite alternatively
@ -36,6 +38,9 @@ $ chmod -R 755 polr
$ chown -R www-data polr
# run only if on Fedora-based systems
$ chown -R apache polr
# run only if on recent Fedora, or other system, with SELinux enforcing
$ chcon -R -t httpd_sys_rw_content_t polr/storage polr/.env
```
## Installing using `composer`