Package: telecms-bridge-base
Service ExchangeDescriptionAbout Service Exchange:https://about.service.exchangeLive Demo:https://app.service.exchange/demoDocumentation:https://docs.service.exchange/Support:support@service.exchangeService Exchangeis a SaaS service that automatically generates extendable back office for your application.Service Exchangeis a standalone app which generates REST API thought which your SQL database is connected toService Exchange.This project has been designed to fit requirements of small startups and mature companies.Data Privacy. Tele-CMS does not access your data: its transferred directly from browser to your application.Customizable Interface. With WYSIWYG interface customization your can change almost every part of interface.Extendable. Flex Features allows you to create your custom Actions, Views, Fields and other.Works with any technology. The interface is generated automatically based on an analysis of the data and data structure of your database.Quick installation. All you need is to install Service Exchange and connect it to your database.FeaturesCRUD (create, read, update, delete)All common operations to view, create, update or delete data.Search and FilterFilter data easily by any field with most common lookups and search them by text occurrence. For some specific cases you can create SQL Segment to filter with.SegmentsSegments allow you to save applied set of filters as a Segment or create it from SQL query for quick use in future.WYSIWYG Interface CustomizationYou can customize almost every part of interface visually – navigation menu, collection list views, record create/update forms.List View layoutA number of out-of-the-box list layouts except default Table View like Kanban Board and Map with markers.DashboardsCreate different types of charts, tables and other widgets to visualize your KPIs or monitor data without programming – inside your visual interface. Complex data queries can be created with SQL.Teams and PermissionsInvite users to collaborate on a project and assign access rights based on their team.ExportYou can export all collection data or part of it into the most common formats like CSV or Excel.Responsive LayoutThe interface is optimized for any device from phones to tablets to desktops.ExtendabilityWhile we are trying to include most of important features out of the box sometimes its not enough. For any specific cases we offer Flex features to implement functionality not available with standard features:Custom ViewsFor very specific pages you can create your own custom FlexView based on React, Angular or any other framework and integrate it inService Exchange interface. Writing your own custom JS/CSS/HTML has no limits in implementing any page you need.Custom ActionsIf need to run some operations on records or any other business logic inside your Backend you can create FlexActions and run them directly fromService Exchange interface. Passing some additional parameters to your Backend is supported.Custom FieldsSometimes using existing fields is not enough and you need to create custom which can be a combination of multiple fields, use fields from related collections and be result of some calculation. In this case you can use FlexField and write your custom JavaScript function which can format fields data any way you want.How It WorksService Exchangeis a SaaS frontend application hosted onService Exchangeside that works in your browser. It connects to your project SQL database through open sourceService Exchangebackend application which you install on your side. So IntegratingService Exchangewith your project requires installing only one component -Service Exchange. Here how it should look like after installation:Your AppAny of your applications which works with yourDatabase.Service Exchangedoes not interact with it directly.DatabaseYour databaseService Exchangehas no direct access to.Service ExchangeAn open source application installed on your server's side and connected to your database. It automatically generates REST API based on your database structure.Tele-CMS Interfaceworks withDatabasethroughService Exchange.Tele-CMS InterfaceWeb application accessible from any browser. Maintaining and updating of this web application is onService Exchangeteam side. Your application data is transmitted directly fromService ExchangetoTele-CMS Interfacein your browser and remain invisible for theService Exchangeservice.RequirementsPython2.7 or 3.4+Any of the followingSQL Databases:PostgreSQLMySQLSQLiteOracleMicrosoft SQL ServerFirebirdSybaseInstallationMethod 1. Using standalone Service ExchangeInstalltelecms_bridgepackage using pip or update if you did it beforepipinstalltelecms_bridge-UInstall appropriate database adapter# for PostgreSQLpipinstallpsycopg2# for MySQLpipinstallmysqlclientRunService Exchangefor your configuration.
You can read about all possible settings atConfigurationpage.DATABASE_ENGINE=postgresql\DATABASE_HOST=host.docker.internal\DATABASE_PORT=5432\DATABASE_NAME=database\DATABASE_USER=postgres\DATABASE_PASSWORD=password\telecms_bridgeRegister your project by opening in your browser:http://localhost:8888/wherelocalhostis yourService ExchangeHOST and8888is its PORT.
If you want to run Service Exchange on different host/port you can configure it (read more atConfigurationpage).If you don't haveTele-CMSaccount yet you will be asked to create one and sign in with the existing account.After registering your project you will be redirected to your project and can start working withTele-CMSAfter registering your project you will be redirected to your project and can start working withTele-CMSMethod 2. Using Service Exchange inside DockerService ExchangehasDockerimage available onDocker Hub.In order start it insideDockerfor your configuration run the following command.
You can read about all possible settings atConfigurationpage.InstallDockerif you don't have ithttps://docs.docker.com/install/Make sureDockeris runningUpdateService Exchangeimage if downloaded it beforedocker pull serviceexchange/telecmsbridgeRunDockercontainer. This will run Service Exchange onhttp://localhost:8888/.If you want to run on different port change it here:
****... -p 9000:8888 ...– this will run on9000dockerrun-p8888:8888\-eDATABASE_ENGINE=postgresql\-eDATABASE_HOST=host.docker.internal\-eDATABASE_PORT=5432\-eDATABASE_NAME=database\-eDATABASE_USER=postgres\-eDATABASE_PASSWORD=password\serviceexchange/telecmsbridgeIf you are usingDocker before 18.03you can't usehost.docker.internalfor DATABASE_HOSTDocker 17.12 – 18.02usedocker.for.mac.host.internalDocker 17.06 – 17.11usedocker.for.mac.localhostDocker 17.05 and belowyourlocal host IP address(can be found usingifconfigcommand)Register your project by opening in your browser:http://localhost:8888/wherelocalhostis yourService ExchangeHOST and8888is its PORT.
If you want to run Service Exchange on different host/port you can configure it by changingDockercontainer port in this command.If you don't haveTele-CMSaccount yet you will be asked to create one and sign in with the existing account.After registering your project you will be redirected to your project and can start working withTele-CMSSupportFeel free to Email us –support@service.exchangeLicenseThis project (Service Exchange) isMITlicensed - see the LICENCE file for details.