{"id":13701273,"url":"https://github.com/iondv/framework","last_synced_at":"2025-04-25T14:31:59.771Z","repository":{"id":53096086,"uuid":"181240425","full_name":"iondv/framework","owner":"iondv","description":"IONDV. Framework is a high level framework for enterprise web applications development. ","archived":false,"fork":false,"pushed_at":"2023-03-06T13:54:15.000Z","size":9895,"stargazers_count":63,"open_issues_count":2,"forks_count":21,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-03T22:41:35.079Z","etag":null,"topics":["enterprise-applications","enterprise-software","framework","iondv","iondv-core","javascript","json","metadata","nodejs","npm","rad","web-framework"],"latest_commit_sha":null,"homepage":"https://iondv.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iondv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-13T23:51:26.000Z","updated_at":"2025-02-09T19:35:26.000Z","dependencies_parsed_at":"2024-11-10T19:34:45.553Z","dependency_job_id":"5758ea9d-82c9-481b-9c2e-2f210489df74","html_url":"https://github.com/iondv/framework","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iondv%2Fframework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iondv%2Fframework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iondv%2Fframework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iondv%2Fframework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iondv","download_url":"https://codeload.github.com/iondv/framework/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250834092,"owners_count":21494907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["enterprise-applications","enterprise-software","framework","iondv","iondv-core","javascript","json","metadata","nodejs","npm","rad","web-framework"],"created_at":"2024-08-02T20:01:25.889Z","updated_at":"2025-04-25T14:31:56.252Z","avatar_url":"https://github.com/iondv.png","language":"JavaScript","readme":"\u003ch1 align=\"center\"\u003e \u003ca href=\"https://www.iondv.com/\"\u003e\u003cimg src=\"/docs/en/images/ION_logo_black_mini.png\" alt=\"IONDV. Framework logo\" width=\"600\" align=\"center\"\u003e\u003c/a\u003e\n\u003c/h1\u003e  \n\n\u003ch4 align=\"center\"\u003eJS framework for rapid business application development\u003c/h4\u003e\n  \n\u003cp align=\"center\"\u003e\n\u003ca href=\"http://www.apache.org/licenses/LICENSE-2.0\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat\" alt=\"license\" title=\"\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch3\u003e\n    \u003ca href=\"https://www.iondv.com/\" target=\"_blank\"\u003e\n      Website\n    \u003c/a\u003e\n    \u003cspan\u003e | \u003c/span\u003e\n    \u003ca href=\"https://www.iondv.com/portal/get-it\" target=\"_blank\"\u003e\n      Get it Free\n    \u003c/a\u003e\n    \u003cspan\u003e | \u003c/span\u003e\n    \u003ca href=\"https://github.com/iondv/framework/docs/en/index.md\" target=\"_blank\"\u003e\n      Documentation\n    \u003c/a\u003e\n  \u003c/h3\u003e\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://twitter.com/ion_dv\" target=\"_blank\"\u003e\u003cimg src=\"/docs/en/images/twitter.png\" height=\"36px\" alt=\"\" title=\"\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.facebook.com/iondv/\" target=\"_blank\"\u003e\u003cimg src=\"/docs/en/images/facebook.png\" height=\"36px\" margin-left=\"20px\" alt=\"\" title=\"\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.linkedin.com/company/iondv/\" target=\"_blank\"\u003e\u003cimg src=\"/docs/en/images/linkedin.png\" height=\"36px\" margin-left=\"20px\" alt=\"\" title=\"\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.instagram.com/iondv/\" target=\"_blank\"\u003e\u003cimg src=\"/docs/en/images/Insta.png\" height=\"36px\" margin-left=\"20px\" alt=\"\" title=\"\"\u003e\u003c/a\u003e \n\u003c/p\u003e\n \n\nЭта страница на [Русском](/docs/ru/readme.md)\n\n\u003ch1 align=\"center\"\u003e \u003ca href=\"https://www.iondv.com/\"\u003e\u003cimg src=\"/docs/ru/images/iondv_readme1.png\" height=\"800px\" alt=\"IONDV. Framework in numbers: rest api, soap, json, yaml, JavaScript - free open source web business application development\" align=\"center\"\u003e\u003c/a\u003e\n\u003c/h1\u003e  \n\n# IONDV. Framework \n\nIONDV. Framework - is a node.js open source framework for developing accounting applications\nor microservices based on metadata and individual modules. Framework is a part of \ninstrumental digital platform to create enterprise \n(ERP) apps. This platform consists of the following open-source components: the [IONDV. Framework](https://github.com/iondv/framework), the\n[modules](https://github.com/topics/iondv-module) and ready-made applications expanding it\nfunctionality, visual development environment [Studio](https://github.com/iondv/studio) to create metadata for the app.\n\n## Description  \n\n**IONDV. Framework** — is a tool for creating high-level web applications based on metadata. You can change the system by adding the additional components to change functionality. There are ready-made modules, but nothing limits you to create new ones to personalize the application. Moreover, it's low-code framework\n\nThe main purpose is the implementation of complex data registry systems. The functional base is the data registry - the Registry module. This is a key module designed specifically to work with data based on metadata structures - including the management of projects, programs, activities, etc.\n\n**IONDV. Framework** is an open source software in JavaScript with open metadata structure in human-readable JSON files.\n\n## How to design an application?\n\n**What?**\nBusiness application of any class.\n\n**How?**\nDescribe the data and apply ready-made modules that you can adjust for specific tasks.\n\n`core + metadata + modules = application`\n\n\u003ch1 align=\"center\"\u003e \u003ca href=\"https://www.iondv.com/\"\u003e\u003cimg src=\"/docs/ru/images/app_structure1.png\" height=\"500px\" alt=\"Application structure - core, metadata, modules\" align=\"center\"\u003e\u003c/a\u003e\n\u003c/h1\u003e  \n\nIn the square frames  - *ioncore*, *meta class*, *meta view*, *meta navigation* and *registry module* - are the base of the simplest application. Below are additional types of meta and modules. They represent additional functionality and could be applied in accordance with the application. Look for the application dependencies in the `package.json` file.\n\n### Typical applications\n\nWe give you a frame for creating applications in JavaScript, both enterprise level and highly functional - from the portal to analytics:\n\n- Document Management;\n- Accounting and Reporting;\n- Enterprise Resource Management;\n- Workflow Management and Project Activities;\n- Data Capture;\n- Business Analytics;\n- System Integration.\n\n### Free Demos\n\nFor now, we have three demos to show you:\n\n* [Studio](https://studio.iondv.com/index) - is an IONDV. Framework specialized IDE that helps you to speed and simplify the development of applications on the IONDV. [GitHub Repo](https://github.com/iondv/studio/tree/master/tutorial/en/index.md). [Tutorial \"How to create an app in IONDV. Studio\"](https://github.com/iondv/nutrition-tickets/blob/master/tutorial/en/index.md)\n* [DNT](https://dnt.iondv.com/auth) - is our application for development and testing, on the basis of which new meta components are implemented and tested. So almost all elements of the system are in the DNT app.[GitHub Repo](github.com/iondv/develop-and-test).\n* [War Archive](https://war-archive.iondv.com/portal/index) - is the IONDV. Framework web-application designed to store, group and demonstrate the data based on archival documents about Great Patriotic War (World War II). [GitHub Repo](https://github.com/iondv/war-archive).\n* [Project Management](https://pm-gov-ru.iondv.com) - is a web enterprise application based on IONDV. Framework. Project management system allows you to organize project activities: to monitor the results, to comply with and reduce the deadlines, to use effectively temporary, human and financial resources, making timely and informed management decisions. [GitHub Repo](https://github.com/iondv/pm-gov-ru)\n* [Telecom](https://telecom-ru.iondv.com) - is a web application based on IONDV. Framework. It is used as a registry to account, store, and present the data on the\navailability of communication services (Internet, mobile communications, television, mail, etc.) in populated areas of the region. [GitHub Repo](https://github.com/iondv/telecom-ru)\n* CRM - *coming soon on GitHub*.\n\nThe login for access is - demo and the password is - ion-demo. No registration required.\n\n## Top features  \n\n**IONDV. Framework** provides the following functionality:\n\n- descriptive metadata into the data storage structure in the DBMS;\n- functionality to work with various DBMS (ORM technology);\n- authorization in a system with different policies, by default oath2, with an open, configurable API for connecting passport library authorization modules which provides up to 500 different authorization policies;\n- securing access to data - static securing to data types, to navigation, to stages of business processes, to actions on a form; dynamic securing- through the conditions in the data that the profile of the current user must correspond to (belonging to the unit or organization specified in the object, group or other conditions); through url; providing exceptions in authorization and security by url or for a special user;\n- connection of modules providing additional functionality and implemented through access to the kernel interfaces (APIs);\n- providing import, export of data in the system, metadata, security from files;\n- providing interaction with the file system for storing data, including external file storages, such as nextcloud;\n- calculating values with formulas and caching this data;\n- providing eager loading and data filtering in connected collections;\n- caching requests and sessions in memcached, redis;\n- scheduled tasks;\n- notification of users by events.\n\nYou can find out [more](/docs/en/key_features.md) about the functionality of the framework and its modules.\n\n## Quick start \n\nYou can get access to the already built applications deployed on Cloud servers or explore the different ways on the [IONDV.Framework site](https://iondv.com), for example:  \n* gitclone with this repository\n* installer for linux operating system\n* docker-container with the already built application\n* archive with the already built application\n\n### Software requirements\n\nInstall [Node.js](\u003chttps://nodejs.org/en/\u003e) runtime and npm package manager to run the IONDV.Framework. Version 10.x.x.   \n\nInstall and run the [MongoDB](https://www.mongodb.org/) DBMS to store the data. Version 3.6.  \n\n### Installer\n\nYou can use [IONDV. Framework apps installer](https://github.com/iondv/iondv-app), requiring installed node.js, mongodb and git. During the installation, all other dependencies will be checked and installed, and the application itself will be built and run.\n\nInstall in one command:\n\n```\nbash \u003c(curl -sL https://raw.githubusercontent.com/iondv/iondv-app/master/iondv-app) -t git -q -i -m localhost:27017 develop-and-test\n```\nWhere  `localhost: 27017` is the MongoDB address, and `develop-and-test` is the app name.\n\nAlso the other way is to clone - (`git clone https://github.com/iondv/iondv-app.git`) and install the app by using the `bash iondv-app -m localhost:27017 develop-and-test` command.\n\nYou can also build the application in Docker containers, then only docker and mongodb DBMS in the Docker container are needed from the environment. For more information, see the [IONDV. Framework apps installer] (https://github.com/iondv/iondv-app)\n\n\u003cdetails\u003e\n  \u003csummary\u003e \n    \u003ch3\u003e \n      Gitclone with repository\n    \u003c/h3\u003e \n  \u003c/summary\u003e\n  \n### Global dependencies\n\nTo build all components and libraries, you need to install the following components globally:\n\n* package [node-gyp](\u003chttps://github.com/nodejs/node-gyp\u003e) `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`\n* [Gulp](\u003chttp://gulpjs.com/\u003e) installation package `npm install -g gulp@4.0`. `4.0` - supported version of `Gulp`\n* package manager of frontend libraries [Bower](\u003chttps://bower.io\u003e) `npm install -g bower`\n\n  \n### Core, modules and application\n\nThe [IONDV. Develop-and-test](https://github.com/iondv/develop-and-test) is an example application.\n\nThe dependencies are listed in the [`package.json`](https://github.com/iondv/develop-and-test/blob/master/package.json) file.\n\n```\n  \"engines\": {\n    \"ion\": \"3.0.0\"\n  },\n  \"ionModulesDependencies\": {\n    \"registry\": \"3.0.0\",\n    \"geomap\": \"1.5.0\",\n    \"portal\": \"1.4.0\",\n    \"report\": \"2.0.0\",\n    \"ionadmin\": \"2.0.0\",\n    \"dashboard\": \"1.1.0\",\n    \"soap\": \"1.1.2\"\n  },\n  \"ionMetaDependencies\": {\n    \"viewlib\": \"0.9.1\"\n  }\n```\n* Install the core, its version is specified in the `engines\": \"ion\": 3.0.0` parameter. Copy the URL of the core repository\n and execute the command `git clone https://github.com/iondv/framework.git dnt`, where `dnt` is a application name, for \n example full path is `/workspace/dnt'. Go to \n the core folder and switch the tag of  the version number `git checkout tags/3.0.0`.\n* Further, install the modules listed in the `ionModulesDependencies` parameter. Navigate to the module folder executing \nthe `cd modules` command. Clone modules from the `ionModulesDependencies` list, for the registry module the command is \n`git clone https://github.com/iondv/registry.git`. Go to the folder of the installed module and switch the tag of the \nversion number `git checkout tags/3.0.0`. Repeat for each module.  \n* To install the application, go to the application folder executing the `cd ..\\applications` command, if you're in the module folder. \nClone the path to repository by `git clone https://github.com/iondv/develop-and-test.git`command. Go to the folder of \ninstalled application and switch the tag of the version number `git checkout tags/2.0.0`. \n* Finally, install all necessary applications listed in the `ionMetaDependencies` parameter in the `applications` folder. \nMake sure that you're inside this folder. Clone the dependencies in `ionMetaDependencies`, in particularly ` viewlib` - \na additional application - library of views templates. Execute the `git clone https://github.com/iondv/viewlib.git` to \nclone to the `applications` folder. Go to the folder of installed application and switch to the tag of the version \nnumber `git checkout tags/0.9.1`. Repeat for each application. \n \n#### Building, configuring and deploying the application\n\nBuilding the application provides installation of all dependent libraries, importing data into the database and preparing \nthe application for launch.  \n\nCreate the configuration file `setup.ini` in the `/config` folder of the core to set the main parameters of the \napplication environment.  \n\n```\nauth.denyTop=false \nauth.registration=false \nauth.exclude[]=/files/**\nauth.exclude[]=/images/**\ndb.uri=mongodb://127.0.0.1:27017/iondv-dnt-db\nserver.ports[]=8888\nmodule.default=registry\nfs.storageRoot=./files\nfs.urlBase=/files\n```\n\nOpen 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 \nbase name that we use for the application. The DB will be created automatically. \n\nSet the `NODE_PATH` environment variable which is equal to the path of the application core. For Windows the command \nis `set NODE_PATH=c:\\workspace\\dnt`, for Linux - `export NODE_PATH=/workspace/dnt`, where `/workspace/dnt` is the directory of \nthe application.   \n\nThe `npm install` installs all key dependencies, including locally the `gulp` build-tool. Please make sure that the Gulp \nversion - is `4.0`. \n\nFurther, execute the `gulp assemble` command to build and deploy the application.\n\nIf you want to import data into your project, check the demo data in the `data` folder of the application and run the command:\n`node bin/import-data --src ./applications/develop-and-test --ns develop-and-test`\n\nAdd the admin user with the 123 password executing the `node bin/adduser.js --name admin --pwd 123` command. \n\nAdd admin rights to the user executing the `node bin/acl.js --u admin@local --role admin --p full` command.\n\n#### Running\n\nRun the app, executing the `npm start` or `node bin/www` command. \n\nOpen this link `http://localhost:8888` in a browser and log in. `8888` —  is a port in the `server.ports` parameter.\n \u003c/details\u003e\n\n\n### Docker\nFollow these steps to deploy docker container on the example of the `develop-and-test` application:\n\n1. Run mongodb DBMS: `docker run --name mongodb -v mongodb_data:/data/db -p 27017:27017 -d mongo`\n2. Run IONDV. develop-and-test `docker run -d -p 80: 8888 --link mongodb iondv/dnt`.\n3. Open the `http://localhost` link in the browser in a minute (it takes time to initialize the data). For back office login: **demo**, password: **ion-demo**\n\n\n## Documentation \n\nThe IONDV.Framework documentation is available in two languages —  [english](/docs/en/index.md) and [russian](/docs/ru/index.md).  \n\n## Links\n\nSome handy links to learn more information on developing applications using IONDV.Framework.\n* [User manual](/docs/en/manuals/user_manual.md)\n* [Developer manual](/docs/en/manuals/dev_manual.md)\n* [Homepage](\u003chttps://iondv.com/\u003e)  \n* Questions on [stack overflow](https://stackoverflow.com/questions/tagged/iondv)\n\n\n--------------------------------------------------------------------------  \n\n\n#### [Licence](/LICENCE) \u0026ensp;  [Contact us](https://iondv.com/portal/contacts) \u0026ensp;  [Russian](/docs/ru/readme.md)   \u0026ensp;           \n\u003cdiv\u003e\u003cimg src=\"https://mc.iondv.com/watch/local/docs/framework\" style=\"position:absolute; left:-9999px;\" height=1 width=1 alt=\"iondv metrics\"\u003e\u003c/div\u003e\n\n\n--------------------------------------------------------------------------  \n\nCopyright (c) 2018 **LLC \"ION DV\"**.  \nAll rights reserved.  ","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiondv%2Fframework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiondv%2Fframework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiondv%2Fframework/lists"}