go-microx

go-microx is a powerful CLI tool designed to streamline the creation of scalable microservices architectures in Golang. It provides a well-structured setup tailored for various industries, including e-commerce, video streaming, food delivery, and more.

Features

• Interactive CLI with PromptUI: User-friendly selection for project templates, database choices, HTTP routers, and configurations.
• Automated Boilerplate Generation: Quickly scaffold a complete microservices project.
• Multiple Project Templates: Choose from predefined templates like E-commerce, Video Streaming, Food Delivery, and more.
• Database Support: Select from PostgreSQL, MongoDB, MySQL, SQLite, or no database.
• Authentication Options: Supports JWT, OAuth, API Key, WebAuthn (upcoming).
• HTTP Router Selection: Choose from Gin, Fiber, Chi, Echo, Mux, or custom routers.
• gRPC Support: Generate microservices with gRPC communication.
• Pre-configured Docker Setup: Seamless containerization with Docker.

Installation

To install go-microx, use the following command:

go install github.com/abhishekkushwahaa/go-microx@latest

Usage

Create a New Microservices Project

Run the following command to start an interactive project setup:

go-microx new

Interactive CLI Flow

The CLI will guide you through project creation using promptui, displaying interactive options for selecting a template, naming your project, choosing a database, and selecting an HTTP router.

Example Interaction:

? Select a project template:
  ▸ E-commerce
    Video-Streaming
    Food-Delivery
    Custom

? Enter project name: myshop

? Select an HTTP Router:
  ▸ Gin
    Fiber
    Chi
    Echo
    Mux
    Custom

? Select a database:
  ▸ PostgreSQL
    MongoDB
    MySQL
    SQLite
    None

? Select an authentication method:
  ▸ None
    JWT
    OAuth
    API Key

🚀 Creating project: myshop
📦 Type: E-commerce
🔌 Router: Gin
🫙 Database: PostgreSQL
🔐 Authentication: None
✅ Project myshop has been successfully created!

Available Project Templates

• E-commerce: Includes user management, product catalog, order processing, payments, and cart service.
• Video Streaming: Includes user authentication, video upload service, transcoding service, content delivery, and analytics.
• Food Delivery: Includes restaurant management, order tracking, delivery assignment, and payment service.

Project Structure

Upon execution, go-microx generates the following structure based on the selected template:

myshop/ (E-commerce)
├── user-service/
│   ├── main.go
│   ├── Dockerfile
│   ├── config.yaml
├── product-service/
├── order-service/
├── payment-service/
├── cart-service/
├── api-gateway/
├── configs/

myvideo/ (Video-Streaming)
├── user-service/
├── video-service/
├── subscription-service/
├── recommendation-service/
├── api-gateway/
├── configs/

Future

• More Industry Templates: Add support for FinTech, SaaS, IoT, Healthcare, etc.
• gRPC Integration: Support for high-performance RPC communication.
• Advanced Authentication: Implement WebAuthn for biometric authentication.
• Service Mesh Support: Integrate Istio and Linkerd.
• Event-Driven Architecture: Native support for Kafka, NATS, and RabbitMQ.
• Service Discovery & API Gateway: Support for Consul, Nginx, and Traefik.
• Load Balancing: Future support for Nginx, Traefik, and Envoy.
• Observability & Monitoring: Integrate OpenTelemetry, Prometheus, and Grafana.
• CI/CD Enhancements: More pre-configured pipelines for deployment.
• Kubernetes Helm Charts: Easy orchestration for microservices.
• Cloud Deployment Support: AWS, GCP, and Azure integration.
• Secure Storage Mechanism: Encrypted data storage and retrieval.
• Concurrency: Efficient support for handling concurrent tasks and processes to improve scalability and responsiveness.

Contributing

We welcome contributions from the community! Feel free to submit issues, feature requests, or pull requests to help improve go-microx. Your contributions are highly valued, but please follow the Contribution Guidelines.

License

go-microx is released under the MIT License. See LICENSE for more details.