Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/isc-rsingh/iris-python-flask-template
https://github.com/isc-rsingh/iris-python-flask-template
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/isc-rsingh/iris-python-flask-template
- Owner: isc-rsingh
- License: mit
- Created: 2020-09-19T18:17:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-19T18:17:14.000Z (over 4 years ago)
- Last Synced: 2024-11-08T14:57:03.230Z (about 2 months ago)
- Language: ObjectScript
- Size: 672 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# InterSystems IRIS Full Stack demo and template
This repository contains a sample application which consists of InterSystems IRIS REST API and Frontend Application which demoes a coffee-maker shop.
It demonstrates the way to communicate with InterSystes IRIS from any frontend application.
It has Unit tests which could be run interactively, or using ZPM, or via Github CI.
It demoes the way to develop using Docker containers.
It demoes how to package the application in ZPM module and how to deploy it using ZPM.
## Installation
### Docker way
Clone the repo, run:
```
docker-compose up -d
```
RUn the application with URL: http://localhost:52775/csp/coffee/index.html#/
### ZPM way
Open IRIS terminal and run ZPM:
```
USER>zpm
zpm:USER>install "demo-coffeemaker"
```
Run the appliction in URL: http://yourserver:52775/csp/coffee/index.html#/
## Development
### Prerequisites
Make sure you have [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Docker desktop](https://www.docker.com/products/docker-desktop) installed.
This repository is ready to code in VSCode with ObjectScript plugin.
Install [VSCode](https://code.visualstudio.com/), [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) and [ObjectScript](https://marketplace.visualstudio.com/items?itemName=daimor.vscode-objectscript) plugin and open the folder in VSCode.
This is a template. So use template button in Github and create a new repository with copy of iris-fullstack-template.
Clone your repository.
Open the folder with VSCode.
Build container as it is shown in the gif:
or open the terminal and run:
```
docker-compose up -d
```
Check if the app is running from the VSCode ObjectScript menu:
All set. You good to start the development.
## Unit Testing
This repository has [U]nit Tests](https://github.com/intersystems-community/iris-fullstack-template/blob/787acb10efae8847e3084db26c3e4211bd5a753a/tests/UnitTest/Demo/coffeemaker.cls).
THere is a [Github Actions CI workflow](https://github.com/intersystems-community/iris-fullstack-template/blob/787acb10efae8847e3084db26c3e4211bd5a753a/.github/workflows/main.yml) in this repo, which performs unit testing with every push to Github repository and fails if tests fail.
But you also can run the test script locally with:
```
COFFEE>set ^UnitTestRoot="/irisdev/app/tests"
COFFEE>do ##class(%UnitTest.Manager).RunTest()
```
Or with ZPM:
```
COFFEE>zpm
zpm:COFFEE>load /irisdev/app
zpm:COFFEE>test demo-coffeemaker
```
## ZPM Package Manager
This module is zpm-packaged, which means that it is described with [module.xml](https://github.com/intersystems-community/iris-fullstack-template/blob/40d39a688df604ef11681c80fc24254a6570fe43/module.xml) and available in public repository and installable with:
zpm "install demo-coffeemaker"
Feel free to use as an example and change the module.xml to package your own InterSystems IRIS full-stack solution.
## Credits
Demo is built using original [Coffee Maker application](https://github.com/intersystems/FirstLook-REST) by Michael Smart a and it's enhanced version by [Caret Dev](https://github.com/caretdev/CoffeeMaker).