Skip to content

Latest commit

 

History

History
36 lines (33 loc) · 23.1 KB

README.md

File metadata and controls

36 lines (33 loc) · 23.1 KB

Introduction

In this folder, you shall find technical documentation for all the packages available in this repository. The documentation is sorted by topic but in the table below, you shall find the relevant documentation per package.

Available Packages and Tools

Package / Tool Description O3r Dependencies related documentation
@o3r/analytics Framework to capture / store and use multiple events (ui, performance etc.) in your application @o3r/core
@o3r/dev-tools
ANALYTICS
TRACK_EVENTS
@o3r/apis-manager Service to help you communicate with your APIs @o3r/dev-tools APIS_MANAGER
@o3r/application Provides development tools for your Otter application @o3r/core
@o3r/dev-tools
@o3r/chrome-devtools Chrome plugin to debug your Otter application N/A chrome-devtools
@o3r/components Component related features (Component replacement, CMS compatibility, helpers, pipes, debugging developer tools...)
Comes with an integrated ng builder
@o3r/analytics
@o3r/build-helpers
@o3r/configuration
@o3r/core
@o3r/dev-tools
@o3r/extractors
@o3r/localization
@o3r/logger
@o3r/schematics
@o3r/testing
COMPONENT INTRODUCTION
COMPONENT_STYLE_OVERRIDE
CONTAINER_PRESENTER
FIXTURES
COMPONENT_REPLACEMENT
CMS_ADAPTERS
@o3r/configuration Configuration related features (CMS compatibility, Configuration override, store and debugging) @o3r/core
@o3r/dev-tools
@o3r/logger
@o3r/testing
OVERVIEW
CONFIGURATION_SUPPORTED_EXTRACTOR
CMS_ADAPTERS
@o3r/core Foundation for all the packages (interfaces, core helpers) and schematics to generate your components/services etc. N/A START_NEW_APPLICATION
DEVELOPER
OTTER_ANGULAR_TOOLS
@o3r/design Tools to generate theme from design materials N/A TECHNICAL_DOCUMENTATION
@o3r/dev-tools Various CLI scripts to help your CI/CD and your dependency management N/A DEV_TOOLS
@o3r/dynamic-content Mechanism to retrieve media and data depending on the host or a server specific url @o3r/core
@o3r/dev-tools
DYNAMIC_CONTENT
LOCALHOST_MIDDLEWARE
@o3r/eslint-plugin In-house eslint plugins to use in your own eslint configuration N/A eslint-plugin
@o3r/extractors Utilities to extract your application metadata to interact with your CMS @o3r/core
@o3r/dev-tools
@o3r/forms Utilities to enhance Angular form (asynchronous decorator, additional validator, error store...) @o3r/core
@o3r/dev-tools
README
FORM_ERRORS
FORM_STRUCTURE
FORM_SUBMIT_AND_INTERCOMMUNICATION
FORM_VALIDATION
@o3r/localization Provide a fallback language/translation support and debug tools @o3r/core
@o3r/dev-tools
LOCALIZATION
CMS_ADAPTERS
@o3r/logger Bridge to target different logger (logrocket, fullstory, smartlook) with a common interface N/A LOGS
@o3r/mobile Helpers and store to integrate Capacitor into your Otter application.
Integration with the pCloudy API for e2e testing on real devices.
@o3r/core
@o3r/logger
@o3r/routing Module to configure an Otter application's routing (POST parameter management, preloading strategy, guard recommendation) @o3r/core
@o3r/dev-tools
REQUEST_PARAMETERS_SERVICE
ROUTING
APP_SERVER_ROUTING
@o3r/rules-engine Rule engine executed on your Otter application to customize your application translations, placeholders and configs based on a json file generated by your CMS @o3r/components
@o3r/configuration
@o3r/core
@o3r/dev-tools
@o3r/dynamic-content
@o3r/extractors
@o3r/localization
@o3r/logger
@o3r/styling
Rules Engine documentation
CMS_ADAPTERS
@o3r/schematics Basic utilities and generic rules (install, lint) reused in other package schematics @o3r/dev-tools
@o3r/storybook Utilities to integrate the Storybook framework to your Otter project @o3r/components
@o3r/configuration
@o3r/core
@o3r/dev-tools
@o3r/localization
@o3r/styling
@o3r/stylelint-plugin In-house stylint plugins to use in your own eslint configuration N/A stylelint-plugin
@o3r/styling Styling framework to apply a theme on an Otter application at build time and runtime to support CMS customization @o3r/core
@o3r/dynamic-content
@o3r/extractors
@o3r/schematics
THEME
TYPOGRAPHY
CMS_ADAPTERS
@o3r/telemetry A set of helpers to retrieve tool usage metrics. N/A PRIVACY NOTICE
@o3r/testing Testing (e2e, unit test) utilities to help you build your own E2E pipeline integrating visual testing @o3r/localization
@o3r/schematics
POST_MESSAGE_INTERCEPTOR
UNIT_TESTS_SETUP
@o3r/third-party Bridge to communicate with third parties via an iFrame solution N/A A/B Testing
@o3r/vscode-extension Various in house VSCode extensions to help you with the development of your Otter application with this IDE (automated generated Otter components etc.) N/A vscode-extension
@o3r/eslint-config-otter Recommended eslint configuration for Otter project @o3r/eslint-plugin eslint-config