rfns / xport

Port web API to read/write Caché files remotely

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

XPort

WARNING: This is a work-in-progress and it might not be ready for production usage.

XPort is a HTTP adapter which uses the Port engine. It aims to bring Port's core principle while removing impeding barriers to work with InterSystems Caché® source codes. Think of it as an alternative to the current Atelier API.

It's made to be used with editors like Visual Studio Code but it can also be used for general purposes.

Features

  • Optimized for big projects (5000+ items).
  • Multiple source code publication and retrieval, including files and binaries.
  • Static files preview, including binaries.
  • Mechanisms to prevent item duplication and accidental deletions.
  • Project compilation and repair.
  • One namespace for all: installing once is enough to work with codes on every namespace.
  • Authentication based on Caché username/password and %Development role.

Requirements

  • InterSystems Caché® 2017 or later, although late 2016 could work as well (not tested).
  • Port.
  • Frontier.

Installation

The fastest way to install XPort is to import and compile the xport-installer, this will install Port and Frontier as well. Just make sure that your instance can access the internet.

After installing it, navigate to this link. If everything is ok, you should see a response link this one:

{
  "version": "0.9.1",
  "application": "/xport/api",
  "namespace": "DEV",
  "dispatcher": "XPort.API"
}

How to use

Users that want to use it should follow the API (not available yet, in development) document. Meanwhile you might want to check out the extension that uses it.

CONTRIBUTING

You can see how to contribute to this project by visiting this document.

LICENSE

MIT.

About

Port web API to read/write Caché files remotely

License:MIT License


Languages

Language:ObjectScript 98.2%Language:Pawn 1.8%