Quick Start - ChrisMavrommatis/Binacle.Net GitHub Wiki
Getting started with Binacle.Net is easy! You can run it locally using Docker or deploy it to the cloud, all with minimal setup. The setup runs Binacle.Net with Swagger UI and the UI Module.
🖥️ Run Locally with Docker
The fastest way to try Binacle.Net is by running it in a Docker container.
1️⃣ Install Docker
Ensure Docker is installed on your system. If not, follow the instructions on the Docker website.
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.
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. Choose one of the provided Samples for a quick start:
- 🔹 Minimal Setup: Set up Binacle.Net with minimal configuration.
- 🔹 Full Deployment: Run Binacle.Net with all features enabled, including Azurite for local storage, Open Telemetry and Aspire Dashboard.
- 🔹 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! 🚀