Developers Documentation

Welcome to the developers documentation for the Fliplet Platform. Here you can learn how to extend your Fliplet Apps and also how to create new components, themes and menus.

To get a brief introduction to the technologies we use and the stack of the platform, we recommend having a quick read at the Introduction to the platform page of the documentation.

Table of contents

1. Introduction to the platform
   • Quickstart
   • The JS APIs
   • Apps Execution flow
2. Building components
   • Components
   • Themes
   • Menus
3. Publishing
4. Testing
5. Working with your components
6. JS API Documentation
7. REST API Documentation
8. UI Guidelines
   • Guidelines for component interfaces
   • Guidelines for component output
9. Theme variables
   • Use theme settings in your custom CSS
10. Advanced documentation
    • Infrastructure Data flow
    • Setting up encryption
    • URLs and IP Addresses
    • Using providers
    • Data Source Hooks
    • Dependencies and assets when building themes and components
    • Sending events between components
    • Context targeting
    • Best practice and advices
    • Using the JS APIs externally
    • Reduce your app’s bundle size
    • Securing your apps
    • Using async/await for more readable promises
    • Custom HTML template for components
    • Making AJAX across different domains
11. Platform-specific advanced functionalities
    • iOS
    • Android
    • Framework Changelog
12. Integrations
    • Fliplet Agent (Data Integration Service)
    • Single Sign-on with SAML2