Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

/ Exports

API Documentation

This is the API documentation for itemize, it is built from the source using typedoc and contains everything that is accessible within, some features are not as important as others concerning development but they are anyway summarized here.

Server and Client are the most important for development.

Core API elements

Base

Represents the base core of the itemize application

Core Elements

Misc

Server

The server section contains utilities and the core code that is used to generate the extended instance, the cluster manager, and the global manager; they all come from the source code that belongs to this section.

Any action related to modifying the server behaviour, custom rest endpoints, creating and defining custom services to be executed in our server is specified in these parts of the API.

Core Elements

Retrieve/Modify Information from Database/Cache.

Services

SEO

SSR

Misc

Client

Represents the code that is used primarily in the client side.

Core Elements

React Components

Util

Item

Localization

Login

Navigation

Offline Status Information

Outdated Status Information

Acessibility

Property IO

Resource Management

Root Information

Search

User Information

Util

USSD Protocol

Fast Prototyping

Misc

Fast Prototyping React Components

Fast Prototyping Renderers

Internal

Providers

Database

Testing

Represents the modules and files that are using for testing and building tests