SDK-JS
Este es el SDK de Octobile para manejar integración entre la aplicación y la página web.
Node.js
Asegúrese de tener instalada la última versión LTS de Node.js.
Este SDK apunta al Nodo 10 por compatibilidad, que se traduce en ES6. Si está utilizando un paquete como el paquete web, probablemente tendrá que transpilar dependencias, incluido este SDK, para que coincida con sus navegadores de destino.
Se recomienda usar en yarn lugar de npm. Consulte la guía de instalación de Yarn si aún no la tiene.
Para hacer uso de la librería, se tendrá que importar manualmente en su proyecto de nodejs (package.json).
Nota: se hará uso de su llave ssh, al momento de instalar la dependencia.
"octobile-sdk": "git+ssh://git@gitlab.com/octo1/octobile-sdk.git"
¿Qué hace este SDK?
Este SDK proporciona un modelo de objetos completo en torno a la API de Octobile Cliente-Servidor
y emite eventos para los datos entrantes y los cambios de estado. Además de envolver la API HTTP:
Autentificación del usuario.(
sdk.auth)Obtención de chats (
sdk.chatService)
Contribuyendo
*Esta sección es para personas que desean modificar el SDK.
Si solo desea utilizar este SDK, omita esta sección.*
Primero, debe incorporar las herramientas de construcción adecuadas:
yarn install
Compilación
Para crear una versión del SDK desde cero al desarrollar:
yarn build
Para ejecutar pruebas (Jasmine):
yarn test
Para ejecutar pruebas (Lint):
$ yarn lint