Quick Start - ChrisMavrommatis/Binacle.Net GitHub Wiki
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.
🖥️ Run Locally with Docker
This option is the fastest if you want to just try it out.
Step 1: Install Docker
Ensure Docker is installed on your system. If not, follow the instructions on the Docker website.
Step 2: Run Binacle.Net
Open your terminal and run:
docker run -d --name binacle-net -p 8080:8080 -e SWAGGER_UI=True -e UI_MODULE=True binacle/binacle-net:latest
This command will:
- Pull the latest Binacle.Net image.
- Start the container with the Swagger UI and UI Module enabled.
- Expose the API on port 8080.
Step 3: Access Binacle.Net
- Swagger UI: http://localhost:8080/swagger/
- UI Module: http://localhost:8080/
📦 Run with Docker Compose
For more advanced setups, you can use Docker Compose with the provided Samples
- Core with Presets: Set up Binacle.Net with custom presets.
- With All Features: Run with all features enabled, including Azurite for local storage.
- UI Module Only: Run Binacle.Net with just the UI Module for quick visual demos.
☁️ Cloud Deployment
Want to deploy Binacle.Net to the cloud? Here are the recommended platforms:
- 🔷 Azure App Service
- 🟠 AWS Elastic Container Service (ECS) or Fargate for serverless container management.
- 🟢 Google Cloud Run
🗂️ Choosing the Right Option
| Deployment | Best For | Platform |
|---|---|---|
| Local (Docker) | Quick development, testing, and demos | Docker |
| Azure | Seamless integration with Microsoft services, scalable web apps | Azure App Service |
| AWS | High-scale microservices, flexible container management | AWS ECS or Fargate |
| Google Cloud | Serverless deployments, cost-effective auto-scaling APIs | Google Cloud Run |
You’re now ready to get started with Binacle.Net—locally or in the cloud! 🚀