Skip to content

swisspost/vertx-rest-storage-editor

Repository files navigation

A swisspost project

vertx-rest-storage-editor

What is this for an editor?

This editor and tree was specific builded for the vertx-rest-storage to show and manage the hosted resources. The Tree is based on the project jstree, the editor is based on jquery and the ace-editor.

Features

Feature Description
Tree view of resources Using a JS tree component (jsTree), the editor shows the folder & file structure of the storage.
In-browser editor Built on Ace Editor, allowing editing of file contents with syntax highlighting, etc.
File operations Create, rename, delete files/folders via the UI.
Resources Import / Export Allow use export resource from backend, and upload a file to backend. need backend supports
Configurable settings Via rest-editor.settings.js in app/js/, parameters can be adjusted: e.g. allowed file types, base path, etc.
Packaging / Deployment Provides build, package scripts (using npm, Grunt) to package the editor for deployment, including zip packaging.
Local development mode npm start to launch a local HTTP server for development and testing.
Integration support Designed to be used in combination with vertx-rest-storage and optionally deployed via vertx-rest-mirror for serving the editor.

How to use it

Download the newest version as zip from Github and extract it in a folder on the vertx-rest-storage. The easiest way to deploy this application (as a zip file) is over the vertx-rest-mirror.

In a other way you can build and test it yourself (see Build / Test at the end of the page).

Editor configuration

In the folder app/js/ you will find the rest-editor.settings.js file. In this file you can setup some parameters for the rest editor.

Build / Test

npm install

You can use the following grunt commands:

grunt               // --> clean, copy, package

grunt build         // clean up and copy the relevant vendor files
grunt package       // create a releasable zip package

Development

npm start

The command npm start starts a http-server and opens web browser with an initial URL (for comfortable development).

About

the web editor for the vertx-rest-storage

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 7