Skip to content

Local Development with Hubtel Scheduling

Hubtel Scheduling Engine is accessible as Docker images from Hubtel's private container registry, enabling seamless integration and local development. You can either download these images individually by following these instructions or use the provided Docker Compose file, which you can download here.

Using Docker Compose

Extract the downloaded file into a directory of your choice. The extracted folder will include the following files:

  • docker-compose.yml: Configuration for launching the various containers that constitute the Hubtel Scheduling Engine project.
  • initdb: Database initialization script

Running Hubtel Authentication

  1. Open a terminal and navigate to the directory containing the extracted files:

    sh
    cd scheduling_engine
  2. Open another terminal in the same directory and start Docker Compose:

    sh
    docker compose -f docker-compose.yml up

Note: Since the Docker container will make API calls to a service hosted on your machine, replace http://localhost in your custom account URL with http://host.docker.internal.

Conclusion

By following the steps above, you can set up and run Hubtel Scheduling Engine locally using Docker Compose. This setup allows you to simulate the scheduled api invocation process and test integrations in a controlled environment. Remember to adjust the API endpoints as necessary to match your local development setup. Happy coding!