Skip to content

Quick Start

Chris Mavrommatis edited this page Oct 1, 2024 · 9 revisions

Getting started with Binacle.Net is simple. You can quickly run it locally using a Docker image, complete with a pre-configured Swagger UI with to interact with all available API calls.

Step 1: Install Docker

Ensure that Docker is installed on your system. If you don’t have it yet, follow the installation instructions on the Docker website.

Step 2: Run Binacle.Net

Launch a terminal or command prompt, and use the following command to pull and run the latest Binacle.Net Docker image:

docker run -d --name binacle-net -p 8080:8080 -e SWAGGER_UI=True chrismavrommatis/binacle-net:latest

This command will:

  • Pull the latest Binacle.Net image.
  • Start the container with the Swagger UI enabled.
  • Expose the API on port 8080.

Step 3: Access the Swagger UI

Once the container is up and running, open your browser and go to:

http://localhost:8080/swagger/

Here, you can explore the Binacle.Net API, test calls, and see sample data—all through an intuitive user interface.

That’s it! You’re now ready to start working with Binacle.Net’s powerful API.

Clone this wiki locally