Read Me First

October 25, 2022 ยท View on GitHub

TBD

Getting Started

Requirements

  • Install docker and docker compose
  • Install JDK-adopt 11
  • Install Kotlin

Installation

  • Clone this repository
  • Using a terminal run the following command on the repository root folder:
    • Init mongo db using docker: docker-compose -f docker-compose.yml up
    • Start the api application: gradle bootRun
  • Go to the browser: http://localhost:8080/swagger-ui/index.html

Application Modes

  • Inviter mode: gradle bootRunInviter
    • Default port: 8081
    • Database name: wal-agent-inviter
  • Invitee mode: gradle bootRunInvitee
    • Default port: 8082
    • Database name: wal-agent-invitee

Connect to MongoDB

  • Host: localhost
  • Port: 27017
  • URL: mongodb://localhost:27017/
  • User: root
  • Pass: secret

Reference Documentation

For further reference, please consider the following sections:

Guides

The following guides illustrate how to use some features concretely:

These additional references should also help you: