Skip to content

IONDV. Framework is a high level framework for enterprise web applications development.

License

Notifications You must be signed in to change notification settings

iondv/framework

Repository files navigation

IONDV. Framework

JS framework for rapid business application development

license

IONDV. Framework

Эта страница на Русском

IONDV. Framework

Description

IONDV.Framework - is a low-code framework for creating high-level web applications based on metadata. Moreover, the framework allows you to change functionality with the additional components, such as ready-made modules or your new ones.

Typical applications:

  • project management system;
  • accounting and data processing registries based on workflows;
  • CRM.

The main advantages of IONDV.Framework are open source software in JavaScript and open metadata structure in human-readable JSON files.

Functionality

  • creation of arbitrary multi-user systems of data recording
  • allocation of access and data security
  • data management based on workflows
  • generation of reports and analytics
  • ability to visualize data on geolayer
  • possibility of arbitrary data display in portal forms
  • easy data integration with REST and SOAP

Quick start with the repository

You can get access to the already built applications deployed on Cloud servers or explore the different ways on the IONDV.Framework site, for example:

  • installer for windows operating system
  • archive with the already built application
  • docker-container with the already built application

System environment

Install Node.js runtime and npm package manager to run the IONDV.Framework. Version 10.x.x.

Install and run the MongoDB DBMS to store the data. Version 3.6.

Global dependencies

To build all components and libraries, you need to install the following components globally:

  • package node-gyp npm install -g node-gyp. For the Windows operating system, it is additionally necessary to install the windows-build-tools package npm install -g --production windows-build-tools
  • Gulp installation package npm install -g [email protected]. 4.0 - supported version of Gulp
  • package manager of frontend libraries Bower npm install -g bower

Core, modules and application

The IONDV. Develop-and-test is an example application.

The dependencies are listed in the package.json file.

  "engines": {
    "ion": "3.0.0"
  },
  "ionModulesDependencies": {
    "registry": "3.0.0",
    "geomap": "1.5.0",
    "portal": "1.4.0",
    "report": "2.0.0",
    "ionadmin": "2.0.0",
    "dashboard": "1.1.0",
    "soap": "1.1.2"
  },
  "ionMetaDependencies": {
    "viewlib": "0.9.1"
  }
  • Install the core, Its version is specified in the engines": "ion": 3.0.0 parameter. Copy the URL of the core repository and execute the command git clone https://github.com/iondv/framework.git dnt, where dnt is a application name, for example full path is /workspace/dnt'. Go to the core folder and switch the tag of the version number git checkout tags/3.0.0`.
  • Further, install the modules listed in the ionModulesDependencies parameter. Navigate to the module folder executing the cd modules command. Clone modules from the ionModulesDependencies list, for the registry module the command is git clone https://github.com/iondv/registry.git. Go to the folder of the installed module and switch the tag of the version number git checkout tags/3.0.0. Repeat for each module.
  • To install the application, go to the application folder executing the cd ..\applications command, if you're in the module folder. Clone the path to repository by git clone https://github.com/iondv/develop-and-test.gitcommand. Go to the folder of installed application and switch the tag of the version number git checkout tags/2.0.0.
  • Finally, install all necessary applications listed in the ionMetaDependencies parameter in the applications folder. Make sure that you're inside this folder. Clone the dependencies in ionMetaDependencies, in particularly viewlib - a additional application - library of views templates. Execute the git clone https://github.com/iondv/viewlib.git to clone to the applications folder. Go to the folder of installed application and switch to the tag of the version number git checkout tags/0.9.1. Repeat for each application.

Building, configuring and deploying the application

Building the application provides installation of all depended libraries, importing data into the database and preparing the application for launch.

Create the configuration file setup.ini in the /config folder of the core to set the main parameters of the application environment.

auth.denyTop=false 
auth.registration=false 
auth.exclude[]=/files/**
auth.exclude[]=/images/**
db.uri=mongodb://127.0.0.1:27017/iondv-dnt-db
server.ports[]=8888
module.default=registry
fs.storageRoot=./files
fs.urlBase=/files

Open the file and paste the text above. The main parameter is db.uri=mongodb://127.0.0.1:27017/iondv-dnt-db. It shows the base name that we use for the application. The DB will be created automatically.

Set the NODE_PATH environment variable which is equal to the path of the application core. For Windows the command is set NODE_PATH=c:\workspace\dnt, for Linux - export NODE_PATH=/workspace/dnt. /workspace/dnt is the directory of the application.

The npm install installs all key dependencies, including locally the gulp build-tool. Please make sure that the Gulp version - is 4.0.

Further, execute the gulp assemble command to build and deploy the application.

If you want to import data into your project, check the demo data in the data folder of the application and run the command: node bin/import-data --src ./applications/develop-and-test --ns develop-and-test

Add the admin user with the 123 password executing the node bin\adduser.js --name admin --pwd 123 command.

Add admin rights to the user executing the node bin\acl.js --u admin@local --role admin --p full command.

Running

Run the app, executing the npm start or node bin/www command.

Open this link http://localhost:8888 in a browser and log in. 8888 — is a port in the server.ports parameter.

Docker

Follow these steps to deploy docker container on the example of the develop-and-test application:

  1. Run mongodb
docker run  --name mongodb \
            -v mongodb_data:/data/db \
            -p 27017:27017 \
            --restart unless-stopped \
            -d \
            mongo
  1. Deploy your IONDV. Develop-and-test and additional applications (import and setup must be performed for all applications)
docker run --entrypoint="" --link mongodb --rm iondv/dnt node bin/import --src ./applications/develop-and-test --ns develop-and-test
docker run --entrypoint="" --link mongodb --rm iondv/dnt node bin/setup develop-and-test --reset
docker run --entrypoint="" --link mongodb --rm iondv/dnt node bin/setup viewlib

If you want to import data into your project, check the demo data in the data folder of the application and run the command:

docker run --entrypoint="" --link mongodb --rm iondv/dnt node bin/import-data --src ./applications/develop-and-test --ns develop-and-test
  1. Create user admin with password 123 and admin role
docker run --entrypoint="" --link mongodb --rm iondv/dnt node bin/adduser --name admin --pwd 123
docker run --entrypoint="" --link mongodb --rm iondv/dnt node bin/acl --u admin@local --role admin --p full
  1. Start application
docker run -d -p 80:8888 --name dnt --link mongodb iondv/dnt

Open http://localhost/ in your browser.

Documentation

The IONDV.Framework documentation is available in two languages — english and russian.

Links

Some handy links to learn more information on developing applications using IONDV.Framework.


iondv metrics

Copyright (c) 2018 LLC "ION DV".
All rights reserved.