README

Repository abandoned 2019-12-31

This repository has moved to laminas-api-tools/api-tools-admin-ui.

This is the source code for the new Apigility Admin User Interface. We rewrote from scratch the UI in AngularJS with performance improvement and usability.

We added some new features:

Doctrine support for DB connected REST service;
DB autodiscovering for table and fields;
Build package API file, ready for deployment (develop in progress, see TODO list);
Per-API authentication (develop in progress, see TODO list);

Note

To be able to run the new UI you need to use the develop branch of zf-apigility-skeleton For instance, you can install the develop branch using composer:
composer create-project zfcampus/zf-apigility-skeleton apigility dev-develop
This command install the zf-apigility-skeleton application in the apigility local folder.

Requirements

npm, for installing the various development requirements, which primarily includes Grunt and Bower, and tools these to utilize.
Grunt must be installed globally in order to allow using it to serve a source build and run tests.
Bower must be installed globally in order to allow using it to install development dependencies.

Run the following command from this directory to install dependencies:

$ npm install

If you have not yet installed Grunt, please do so:

$ sudo npm install -g grunt

If you have not yet installed Bower, please do so:

$ sudo npm install -g bower

Finally, invoke Bower to install the relevant CSS and JS libraries:

$ bower install

Invoking the Admin

There are three ways to invoke the Admin UI: as part of an Apigility project, standalone via node, or via source using grunt.

Via Apigility

Add the admin as a dev requirement to your project:

$ composer require-dev "zfcampus/zf-apigility-admin-ui:~1.0"

and add the module ZF\Apigility\Admin\Ui to the list of modules in config/development.config.php.dist (and potentially config/development.config.php if already in development mode.

Navigating to the URI /apigility/ui in your Apigility application will now hit the UI.

Standalone

The standalone method fires up a webserver using node. This method requires that you have a running Apigility Admin API and know the URL, and that that server is configured to enable CORS; see the Apigility CORS documentation if you need help setting this aspect up. Make a note of the URI for your server; the API URI will be <server>/apigility/api.

Additionally, we recommend noting the URI to your API documentation, so that the navigation item can point to it.

Fire up the admin UI using:

$ node index.js --src --api=<URI to Apigility Admin API (ends in /apigility/api)>

(For help with options, see node index.js -h.)

By default, if you do not specify a port, the server will run on port 3000; you can specify a port with the --port=<port> option.

Source invocation via Grunt

The grunt serve command does several things:

Runs grunt watch, which looks for file changes and runs tasks such as jshint, unit tests, and combining partials into JS templates.
Runs a livereload, static HTTP server; any file change will force it to reload, and trigger any browser windows with the UI loaded to reload.

The grunt server runs in the same way as the standalone server: it accepts the same options, and has the same CORS limitations. As an example:

$ grunt serve --api=<URI to Apigility Admin API (ends in /apigility/api)> \
> --doc=<URI to API documentation> --port=3001 --host=ag.dev

Please see our contributing guide for information on how to run tests and hack on the UI.

zfcampus / zf-apigility-admin-ui

Maintainers

Details