Horda Local Host #

horda_local_host is a Dart project designed to act as a local host for running server packages developed with the horda_server framework. It leverages build_runner for code generation, specifically to create a bin/main.dart file that registers and launches "entities", "services", and "processes" defined within the project. This project is a core component for for local development and testing applications built on the Horda framework.

Usage #

1. Add as a Development Dependency #

Add horda_local_host as a development dependency to your project:

dart pub add dev:horda_local_host

Alternatively, you can manually add it to your project's pubspec.yaml file:

dev_dependencies:
  horda_local_host: ^0.1.0 # Use the appropriate version

Then, fetch all necessary Dart packages by running:

dart pub get

2. Generate Code #

This project uses build_runner to generate the bin/main.dart file, which is essential for running the application. To generate the code:

dart run build_runner build

Note that build_runner will only regenerate bin/main.dart if it detects changes in other Dart files. If you have manually modified bin/main.dart and wish to regenerate it, you must first clean the build cache before running the build command again.

dart run build_runner clean
dart run build_runner build

3. Run the Application #

After generating the main.dart file, you can run the local host in VSCode by pressing F5. Alternatively, you can run it from the command line as usual:

dart bin/main.dart

4. Connect Client #

To connect your client application to the local host, use the following WebSocket address:

ws://localhost:8080/client

Note for Android Emulators: If you are running your client application on an Android emulator, localhost refers to the emulator's own loopback interface, not your development machine. To connect to the local host running on your development machine from an Android emulator, you must use the special alias 10.0.2.2 instead of localhost.

Therefore, the WebSocket address for Android emulators would be:

ws://10.0.2.2:8080/client