meeting_place_chat 0.0.1-dev.32

meeting_place_chat: ^0.0.1-dev.32 copied to clipboard

example/README.md

Chat SDK Examples #

Check the sample code to learn how to use Affinidi Meeting Place - Chat SDK package to enable chatting with others using Decentralised Identifiers (DIDs) and the DIDComm v2.1 protocol.

Running the Examples #

Execute the example Dart scripts from the packages/meeting_place_chat/example folder. To run them, you need to provide environment variables for CONTROL_PLANE_DID and MEDIATOR_DID. The examples use the dotenv package to load these values from a local .env file for convenience.

1. Create your local environment file

   Run this command in your terminal to copy the template and create .env in the root of the example folder:

   cp templates/.example.env .env
   

   Edit .env and update the values for CONTROL_PLANE_DID and MEDIATOR_DID to match your test environment.

2. Run the example scripts

   You can now run the examples directly using Dart:

   # Chat example
   dart run chat/alice.dart
   dart run chat/bob.dart
   

   # Group chat example
   dart run group_chat/alice.dart
   dart run group_chat/bob.dart
   dart run group_chat/charlie.dart
   

   The example utilities will automatically load variables from .env in the root of the example folder.

Notes:

• The .env file should be placed in the root of the example folder as .env.
• The template file is provided at templates/.example.env for convenience.
• If .env is missing, the code will fall back to environment variables from the platform (useful for CI or manual export).