Skip to content

Commit

Permalink
Creating Tag v6.0.0-RC1 at 2020-01-06 - ignoring test folder for pack…
Browse files Browse the repository at this point in the history
…agist distro
  • Loading branch information
ffflabs committed Jan 7, 2020
1 parent 25223f3 commit bf0e617
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 853 deletions.
68 changes: 35 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# phpPgAdmin6

PHP Based administration tool for PostgreSQL. Blazing fast routing with [Slim Framework 3](https://www.slimframework.com/) and solid abstraction layer in its core with [AdoDB](https://adodb.org/). Originally forked from [phppgadmin/phppgadmin](https://github.com/phppgadmin/phppgadmin).

[![Packagist](https://img.shields.io/packagist/dm/huasofoundries/phppgadmin6.svg)](https://packagist.org/packages/huasofoundries/phppgadmin6)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/289a56c1c7d94216b3d089c220689e9e)](https://www.codacy.com/app/amenadiel/phpPgAdmin6?utm_source=github.com&utm_medium=referral&utm_content=HuasoFoundries/phpPgAdmin6&utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/289a56c1c7d94216b3d089c220689e9e)](https://www.codacy.com/app/amenadiel/phpPgAdmin6?utm_source=github.com&utm_medium=referral&utm_content=HuasoFoundries/phpPgAdmin6&utm_campaign=Badge_Grade)
[![StyleCI](https://styleci.io/repos/21398998/shield?branch=develop)](https://styleci.io/repos/21398998)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/HuasoFoundries/phpPgAdmin6/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/HuasoFoundries/phpPgAdmin6/?branch=develop)
[![Build Status](https://scrutinizer-ci.com/g/HuasoFoundries/phpPgAdmin6/badges/build.png?b=develop)](https://scrutinizer-ci.com/g/HuasoFoundries/phpPgAdmin6/build-status/develop)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FHuasoFoundries%2FphpPgAdmin6.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FHuasoFoundries%2FphpPgAdmin6?ref=badge_shield)

PHP Based administration tool for PostgreSQL.

This is a hard fork of [phppgadmin](https://github.com/phppgadmin/phppgadmin) which adds the following enhancements:

- Composer Installation and dependency management
Expand All @@ -17,33 +17,16 @@ This is a hard fork of [phppgadmin](https://github.com/phppgadmin/phppgadmin) wh
- Removal of global variables
- Full PHP 7+ support
- Support for PG 9.3+ features (Materialized Views, BRIN Indexes, etc)
- Nice urls

### WIP

Other enhancements are in progress and would be a nice to have:

- Nice urls
- Replace usage of superglobals with [PSR-7 Message interfaces](http://www.php-fig.org/psr/psr-7/) to carry information around.
- Usage of Dependency Injection compliant with [PSR-11 Container interface](http://www.php-fig.org/psr/psr-11/)


This project is made on top of [Slim Framework 3](https://www.slimframework.com/), although a big part of the code doesn't use its full features yet.


## Credits & FAQ

We're preserving due credits to all people that contributed in the past, as well as other release notes
contained in the old version of [phppgadmin](https://github.com/phppgadmin/phppgadmin)

- [Bugs](docs/BUGS.md)
- [Changelog](docs/CHANGELOG.md) (*outdated*)
- [Credits](docs/CREDITS.md)
- [Developers](docs/DEVELOPERS.md)
- [FAQ](docs/FAQ.md) (*outdated*)
- [History](docs/HISTORY.md) (*outdated*)
- [Translators](docs/TRANSLATORS.md)

Kudos to all people that helped build the original project, upon which this one was built.


This project is made on top of [Slim Framework 3](https://www.slimframework.com/) and communicates with the Database using [AdoDB](https://adodb.org/)

## Installation

Expand All @@ -53,9 +36,8 @@ Kudos to all people that helped build the original project, upon which this one

Install with composer running the following command in your shell (replacing <FOLDER> whith your desired folder name)


```sh
composer create-project huasofoundries/phppgadmin6 <FOLDER> *@beta
composer create-project huasofoundries/phppgadmin6 <FOLDER> v6.0.*@rc --no-dev --prefer-dist
```

Alternatively, clone this repo and run (inside then folder where the project was cloned)
Expand All @@ -64,10 +46,19 @@ Alternatively, clone this repo and run (inside then folder where the project was
composer install --no-dev
```

#### Installing dev branch

If there's something broken and I cannot risk breaking the rest to fix your issue, I might push a fix or feature to [develop branch](https://github.com/HuasoFoundries/phpPgAdmin6/tree/develop). Said branch can be installed as

```sh
composer create-project huasofoundries/phppgadmin6 <FOLDER> *@beta --no-dev --prefer-dist
```

(or, you know, clone the repo and make sure you're in develop branch)

## Rewrite Rules

As this project is built over [Slim Framework 3](https://www.slimframework.com/), **you'll need some rewrite rules for this software to work**.
As this project is built over [Slim Framework 3](https://www.slimframework.com/), **you'll need some rewrite rules for nice-urls to work**.

### Apache

Expand All @@ -89,7 +80,7 @@ Add the following vhost to your `sites-enabled` folder

```
server {
listen 80;
listen 80;
# or whatever port you want
server_name yourservername.com;
Expand All @@ -99,11 +90,11 @@ server {
index index.php;
# Use this block if you're running in your domain or subdomain root
location / {
try_files $uri $uri/ /index.php$is_args$args;
}
location / {
try_files $uri $uri/ /index.php$is_args$args;
}
# If running inside a subfolder use instead
# If running inside a subfolder use instead
#location /subfolder/ {
# try_files $uri $uri/ /subfolder/index.php$is_args$args;
#}
Expand Down Expand Up @@ -131,13 +122,24 @@ server {

Please note that you have to customize your server name, php upstream (sock or IP) and optinally the subfolder you want phpPgAdmin6 to run on.


## License

This work is licensed under MIT or GPL 2.0 (or any later version) or BSD-3-Clause
You can choose between one of them if you use this work.

`SPDX-License-Identifier: MIT OR GPL-2.0-or-later OR BSD-3-Clause`

## Credits & FAQ

We're preserving due credits to all people that contributed in the past, as well as other release notes
contained in the old version of [phppgadmin](https://github.com/phppgadmin/phppgadmin)

- [Bugs](docs/BUGS.md)
- [Changelog](docs/CHANGELOG.md) (_outdated_)
- [Credits](docs/CREDITS.md)
- [Developers](docs/DEVELOPERS.md)
- [FAQ](docs/FAQ.md) (_outdated_)
- [History](docs/HISTORY.md) (_outdated_)
- [Translators](docs/TRANSLATORS.md)

Kudos to all people that helped build the original project, upon which this one was built.
1 change: 0 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@
"kint-php/kint": "~3.3",
"codeception/codeception": "*",
"simpletest/simpletest": "^1.1",
"friendsofphp/php-cs-fixer": "^2.16",
"php-console/php-console": "^3.1",
"codeception/module-asserts": "^1.1"
},
Expand Down
Loading

0 comments on commit bf0e617

Please sign in to comment.