Download the PHP package zfcampus/zf-apigility-admin-ui without Composer
On this page you can find all versions of the php package zfcampus/zf-apigility-admin-ui. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package zf-apigility-admin-ui
Apigility Admin UI (develop branch)
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:
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:
If you have not yet installed Grunt, please do so:
If you have not yet installed Bower, please do so:
Finally, invoke Bower to install the relevant CSS and JS libraries:
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:
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:
(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 asjshint, 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:
Please see our contributing guide for information on how to run tests and hack on the UI.
