SendBird Desk SDK JavaScript

SendBird Desk SDK für JavaScript

Dieses Projekt stellt das SendBird Desk SDK für JavaScript bereit, das das SendBird Messaging SDK für JavaScript, den SendBird Desk SDK Core und das SendBird Desk Widget-Beispiel umfasst

Installieren

Hinweis: Stellen Sie sicher, dass Sie Node-JS 18 und NPM V9 oder höher installiert haben

 npm install
npm run build

Hinweis: Wir verwenden dts-bundle-generator da wir eine einzelne d.ts Datei für das SDK benötigen. rollup-plugin-typescript2 Fehler treten auf, wenn wir versuchen, declaration: true in tsconfig.json zu verwenden.

Einrichten von Tests

Kopieren Sie .env.example nach .env und geben Sie die Werte ein.

Diese Variablen sollten auch in Circle-CI eingerichtet werden. https://app.circleci.com/settings/project/github/sendbird/desk-js/environment-variables

Hinweis: Umgebungsvariablen finden Sie in 1password – engineering/desk_staging_e2e_test. Um sich als Administrator im Dashboard anzumelden, verwenden Sie E2E Admin - Dev in 1password

Prüfen

Wir verwenden jest mit js-dom zum Testen. Testfälle befinden sich im Verzeichnis test/cases und heißen „*.test.ts“.

Hinweis: Versuchen Sie, Tests nicht im automatischen Überwachungsmodus auszuführen. Wir würden für jeden Testfall eine Verbindung zum Server herstellen und trennen

Lokaler Test

 npm run test

Veröffentlichung noch nicht implementiert / möglicherweise Github-Aktion verwenden

1. Stellen Sie sicher, dass der Hauptzweig auf dem neuesten Stand ist.
2. Schneiden Sie einen Release-Zweig aus – release/v#.#.## .
3. Im Release-Zweig:

• Changelog vorbereiten
• Aktualisieren Sie die Version in der Datei package.json .

4. Machen Sie PR zum Hauptzweig. { optionale Schritte
5. Release erstellen -> npm run build; npm publish --tag beta
6. Überprüfen Sie, ob der Release Candidate startklar ist. }
7. PR mit dem Hauptzweig zusammenführen.
8. Release erstellen -> npm run build; npm publish
9. Versionshinweis zur Github-Version hinzufügen.
10. Kopieren Sie CHANGELOG , LICENSE , dist und package.json in https://github.com/sendbird/SendBird-Desk-SDK-JavaScript Repo-Hauptzweig.

Hübscher

 npm run format

oder (in Visual Studio Code) Installieren Sie Prettier - Code formatter Plugin. Öffnen Sie die Datei, um sie hübscher anzupassen, wählen Sie alle aus ( cmd+a ) und cmd+k, cmd+f .

Flusen

 npm run lint

Browser-Unterstützung

• Moderne Browser, die ES6+ unterstützen (Chrome, Firefox, Edge, Safari usw.)
• Mobile Browser (Android/iOS)