pgadmin4

mirror of https://github.com/pgadmin-org/pgadmin4.git synced 2024-11-23 01:06:31 -06:00

pgAdmin is the most popular and feature rich Open Source administration and development platform for PostgreSQL, the most advanced Open Source database in the world.

administration database dba management postgres postgresql postgresql-database

Go to file

Surinder Kumar 1aeab98a2b Load, and save the files in the Query Editor. Also, the changes done by Ashesh to resolved few issue with the file manager in 'Select' mode.		2016-05-14 15:29:08 +05:30
docs/en_US	Add some initial dialog docs.	2016-05-13 14:43:57 +01:00
pkg/pip	Add a top level Makefile with a target and appropriate Python stuff to build a PIP package of the web code.	2016-03-14 10:26:59 +00:00
runtime	Search path for the runtime when running in a Mac dev env.	2016-05-10 16:39:02 +01:00
web	Load, and save the files in the Query Editor.	2016-05-14 15:29:08 +05:30
.gitignore	Ignore the regression test config file.	2016-04-17 10:52:31 -04:00
libraries.txt	Added support for the server side file manager, which will be useful in	2016-05-13 00:04:32 +05:30
LICENSE	Copyright updates for 2016.	2016-01-18 14:48:14 +00:00
Makefile	Fix PIP packaging code so it works nicely on Linux and Mac.	2016-03-15 11:46:04 +00:00
README	Remove a duplicate code line and add Windows environment setup info.	2016-02-03 09:58:58 +00:00
requirements_py2.txt	Initial version of a regression test framework	2016-04-17 10:39:08 -04:00
requirements_py3.txt	Initial version of a regression test framework	2016-04-17 10:39:08 -04:00
TODO.txt	Add a TODO list.	2016-05-06 14:56:03 +01:00

README

pgAdmin 4
=========

pgAdmin 4 is a rewrite of the popular pgAdmin3 management tool for the
PostgreSQL (http://www.postgresql.org) database. 

At present, it is an experimental/proof of concept project. Use at your own
risk, and don't blame us if it breaks anything!

Architecture
------------

pgAdmin 4 is being written as a web application in Python, using jQuery and 
Bootstrap for the client side processing and UI. On the server side, Flask is
being utilised.

Although developed using web technologies, we intend for pgAdmin 4 to be usable
either on a web server using a browser, or standalone on a workstation. The
runtime/ subdirectory contains a QT based runtime application intended to allow
this - it is essentially a browser and Python interpretor in one package which
will be capable of hosting the Python application and presenting it to the user
as a desktop application.

Building
--------

To build the runtime, the following packages must be installed:

- QT 4.6 or above (older versions may work, but haven't been tested).
- Python 2.6 or above.

Assuming both qmake and python-config are in the path:

$ cd $PGADMIN4_SRC/runtime
$ qmake
Project MESSAGE: Building for QT5+...
$ make
...

On Linux, an executable called 'pgAdmin4' will be built, and on Mac OS X, an
app bundle called pgAdmin4.app will be created.

To build the runtime on a Windows system, export PYTHON_HOME and PYTHON_VERSION 
variables in the System environment. Specify the PYTHON_VERSION with the major 
and minor number. Do not specify micro level version.
For example, given a Python version of A.B.C; A - Major number, B - Minor number, 
C - Micro level (Bug fix releases).

If Python version is 2.7.2 than specify PYTHON_VERSION=27

 e.g. PYTHON_HOME=C:\Python27\
      PYTHON_VERSION=27

Support
-------

pgAdmin 4 is completely experiemental and unsupported!

Project info
------------

The source code repository can be found here:

http://git.postgresql.org/gitweb/?p=pgadmin4.git;a=summary

A Redmine project for pgAdmin 4 can be found at the address below. A PostgreSQL
community account is required to access this site. Please note that at present
only project developers can log bug and feature requests:

https://redmine.postgresql.org/projects/pgadmin4

If you wish to discuss pgAdmin 4, or contribute to the project, please use the
pgAdmin Hackers mailing list:

pgadmin-hackers@postgresql.org

-- 
Dave Page
pgAdmin Project Lead