realworld-intersystems-iris


Follow
4
Star
5
Details
Releases
Issues
This application is not supported by InterSystems Corporation. Use it at your own risk.

What's new in this version

community article link

InterSystems IRIS Starter kit for new RealWorld framework implementations

CI codecov

RealWorld Example App

InterSystems IRIS codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

Demo    RealWorld

This codebase was created to demonstrate a fully fledged fullstack application built with InterSystems IRIS Data Platform including CRUD operations, authentication, routing, pagination, and more.

We've gone to great lengths to adhere to the InterSystems IRIS Data Platform community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

InterSystems IRIS Data Platform

InterSystems IRIS Data Platform makes it easier to build high-performance, machine learning-enabled applications that connect data and application silos.

It provides high performance database management, interoperability, and analytics capabilities, all built-in from the ground up to speed and simplify your most demanding data-intensive applications.

As a complete, cloud-first data platform, InterSystems IRIS eliminates the need to integrate multiple technologies, resulting in less code, fewer system resources, less maintenance, and higher ROI.

How it works

REST API and data storage realized on InterSystems IRIS.

.
├── docker-compose.yml  // docker-compose configuration
│
│                       // backend and data server on InterSystems IRIS
├── src                 // source code
├── test                // unit-tests for IRIS
├── Installer.cls       // backend installer in InterSystems IRIS
│
└── web                 // any dockerized frontend
                        // with proxy for `/api` 
                        // to backend http://server:52773/conduit internally

Backend on InterSystems IRIS available by default port on http://server:52773/conduit. In docker-compose configuration uses port 12000, and will be available by http://localhost:12000/conduit

Getting started

Install docker and docker-compose

https://docs.docker.com/engine/install/

https://docs.docker.com/compose/install/

Build images

docker-compose build 

Start

docker-compose up -d

Open URL http://localhost/

Testing

Run Postman/newman tests for REST API. Requires npm and npx package installed (npm i -g npx)

APIURL=http://localhost:12000/conduit ./run-api-tests.sh

Run UnitTests with ZPM

$ docker-compose exec server iris session iris

CONDUIT> zpm "test realworld -v"

Testing with different frontend

By default it uses vue frontend, but prepared to use with angular and react frontends. Command to switch to another frontend. Select one of the following command

web=react docker-compose build web
web=angular docker-compose build web
web=vuew docker-compose build web

And start selected fronted by command

docker-compose up -d web
ZPM installation
zpm "install realworld"
Category
Technology Example
Works with
InterSystems IRIS
Tags
Info
Version
1.0.3
Last updated
2020-10-06
Repository
Open
Documentation
Open
License
Link