Fork me on GitHub
VST Utils
  • DOCS NAVIGATION
    • Home

    Contents:

    • Quick Start
    • Configuration manual
    • Backend API manual
    • VST Utils frontend
    • Redefinition of VST Utils frontend
    • VST Utils JavaScript functions
    • Application loading on frontend
    • Parsing of OpenAPI schema
    • Root classes providing application work

Watch us on GitHub

VST Utils documentation

Welcome to VST Utils documentation¶

VST Utils is a small framework for quick generation of single-page applications. The main feature of the VST Utils framework is autogenerated GUI, which is forming based on the OpenAPI schema. OpenAPI schema is a JSON, that contents description of the models used in the REST API and info about all paths of the application.

In this documentation you can find info about QuickStart of new project based on VST Utils, description of base models, views and fields available in the framework, and also you will know how you can redefine some standard models, views and fields in your project.

Contents:

  • Quick Start
    • New application creation
    • Adding new models to application
  • Configuration manual
    • Introduction
    • Main settings
    • Database settings
    • Cache settings
    • Locks settings
    • Session cache settings
    • Rpc settings
    • Worker settings
    • SMTP settings
    • Web settings
    • Centrifugo client settings
    • Storage settings
    • Production web settings
    • Configuration options
  • Backend API manual
    • Models
    • Web API
    • Endpoint
    • Testing Framework
    • Utils
  • VST Utils frontend
    • Frontend src entry points
    • Association with back-end entities
    • Model class
    • QuerySet class
    • View class
    • Fields classes
  • Redefinition of VST Utils frontend
    • Signals
    • Signals available in VST Utils
    • Class inheritance
    • Customizing field’s Vue component
    • Customizing field using dynamic format
  • VST Utils JavaScript functions
    • String.format()
    • String.format_keys()
    • trim(s)
    • capitalizeString(string)
    • sliceLongString(string=””, valid_length=100)
    • isEmptyObject(object)
    • addCssClassesToElement(element=””, title=””, type=””)
    • getCookie(name)
    • deepEqual(x, y)
    • stringToBoolean(string)
    • oneCharNumberToTwoChar(n)
    • allPropertiesIsObjects(obj)
    • arrayBufferToBase64(buffer)
    • randomString(length, abc=”qwertyuiopasdfghjklzxcvbnm012364489”)
    • hexToRgbA(hex, alpha=1)
    • getTimeInUptimeFormat(time)
    • findClosestPath(paths, current_path)
    • cleanAllCacheAndReloadPage()
    • cleanOpenApiCacheAndReloadPage()
    • updateGuiVersionsInLocalStorage()
    • createDomElement(type, attributes, props)
    • onLoadingErrorHandler(event)
  • Application loading on frontend
    • Application loading steps
    • Optimization of application loading
    • FilesCache class
    • AppDependenciesLoader class
    • OpenApiLoader class
    • StaticFilesLoader class
  • Parsing of OpenAPI schema
    • BaseEntityConstructor class
    • ModelConstructor class
    • ViewConstructor class
    • SubViewWithOutApiPathConstructor class
  • Root classes providing application work
    • App class
    • ApiConnector class
    • ErrorHandler class
    • RouterConstructor class
    • StoreConstructor class
    • PopUp class
    • LocalSettings class
    • GuiCustomizer class
© 2018-2021, VST Consulting