Omni-Backend Node Package

Overview

This Node.js package, OmniSphere, provides essential classes and modules for Siemens Energy LLC's OmniSphere project. The package includes modules for handling applications, countries, currencies, forex, notifications, regions, tenants, and users. Additionally, it contains various helper functions, shared interfaces, and shared schemas. .

Table of Contents

• Installation
• Usage
• License
• Contact

Installation

To install the OmniSphere package, use the Node Package Manager (NPM):

npm install '@mohamed.abdelall/omni-backend'

Usage

import ApplicationModule from '@mohamed.abdelall/omni-backend';

function doMagic(){
    const app = new ApplicationModule.Application('database-name');
    app.Model().find().then((apps) => {}).catch(error => {});
}

Modules

• ApplicationModule: Module for handling applications.
• TenantModule: Module for handling tenants.
• UserModule: Module for handling users.
• NotificationModule: Module for handling notifications.
• CountryModule: Module for handling countries.
• RegionModule: Module for handling regions.
• CityModule: Module for handling cities.
• TimezoneModule: Module for handling timezones.
• CurrencyModule: Module for handling currencies.
• ForexModule: Module for handling forex.
• HelpersModule: Module containing various helper functions.
• SharedInterfaces: Shared interfaces used across modules.
• SharedSchema: Shared schemas used across modules.
• SharedMiddleware: Shared middleware used within the OmniSphere ecosystem.

Author

• Mohamed Abdelall
• Email: [email protected]

Date

• 2023-01-11

Note: This README serves as a reference for the central export file in the OmniSphere project. For detailed documentation on each module, helper, interface, or schema, please refer to the corresponding source code and documentation within each individual module.