https://github.com/nidea1/go-gavel

goGavel is a gRPC-based online auction platform built with Go, structured as a microservices monorepo. This project is developed for learning and self-improvement.
https://github.com/nidea1/go-gavel

auction auctions clean-architecture cqrs cqrs-pattern docker event-driven-architecture event-driven-microservices gavel go golang grpc kafka microservice microservices

Last synced: about 2 months ago
JSON representation

goGavel is a gRPC-based online auction platform built with Go, structured as a microservices monorepo. This project is developed for learning and self-improvement.

• Host: GitHub
• URL: https://github.com/nidea1/go-gavel
• Owner: nidea1
• License: mit
• Created: 2025-01-29T18:45:09.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-02-17T21:41:58.000Z (3 months ago)
• Last Synced: 2025-02-17T22:29:38.271Z (3 months ago)
• Topics: auction, auctions, clean-architecture, cqrs, cqrs-pattern, docker, event-driven-architecture, event-driven-microservices, gavel, go, golang, grpc, kafka, microservice, microservices
• Language: Go
• Homepage:
• Size: 307 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  



## 1. Introduction

goGavel is a gRPC-based online auction platform built with Go, structured as a microservices monorepo. This project is developed as a learning exercise to explore microservices architecture, gRPC communication, and scalable system design with Go.

The goal of goGavel is to provide a real-time auction system where users can place bids, manage their auctions, and experience a high-performance distributed system. This project focuses on best practices in Go, efficient inter-service communication with gRPC, and clean architecture principles.

## 2. Key Features

- 🚀 **gRPC** - High-performance RPC framework

- 📦 **Protobuf** - Efficient data serialization

- 🐳 **Docker** - Containerized development and deployment

- 🐘 **PostgreSQL** - Robust data persistence

- 🔧 **Makefile** - Simplified build automation

- ⚙️ **Environment Variables** - Flexible configuration

- 🎯 **Clean Architecture** - Maintainable and testable code

## 3. Core Services

- **Auth** - User authentication and authorization

- **Auction** - Auction management

- **Bid** - Real-time bidding

- **Payment** - Payment processing




... and more to come!

## 4. Directory Structure

```plaintext

go-gavel-microservices/

├── proto/                              # Protobuf files

│   ├── auth/

│   ├── common/                         # Shared messages and enums

│   ├── ...

│   └── go.mod

├── services/                           # Service implementations

│   ├── auth/

│   │   ├── go.mod

│   │   ├── api/                        # gRPC API handlers

│   │   ├── cmd/

│   │   │   └── main.go                 # Service entry point

│   │   ├── docs/                       # API documentation

│   │   └── internal/

│   │       ├── domain/                 # Domain models

│   │       ├── usecase/                # Business logic

│   │       │   ├── command/

│   │       │   └── query/

│   │       ├── repository/             # Data access layer

│   │       └── events/                 # Event handlers

│   │           ├── publisher.go

│   │           └── consumer.go

│   └── ...

├── pkg/                                # Shared packages

│   ├── utils/                          # Utility functions, validators, and helpers

│   │   └── ...

│   ├── errors/                         # Custom error types

│   │   └── ...

│   ├── grpc/                           # gRPC helpers, interceptors, and middleware

│   │   └── ...

│   ├── database/                       # Database connection and query builder

│   │   └── ...

│   ├── kafka/                          # Kafka producer and consumer

│   │   └── ...

│   ├── ...

│   └── go.mod

├── build/                              # Dockerfiles for building the services 

│   ├── base/                           # Base builder image for all services includes Go + Protobuf + gRPC

│   ├── auth/                           # Auth service builder image

│   └── ...

├── .envs/                              # Environment variables

│   ├── .local/                         # Local development environment variables

│   └── ...

├── scripts/                            # Helper scripts

│   ├── generate_protos.sh

│   └── ...

├── Makefile

├── .gitignore

├── .dockerignore

├── docker-compose.local.yml

├── figures/                            # Diagrams and images for documentation

│   └── ...

├── LICENSE

└── README.md

```

## 5. Project Status

### 1. Service Implementation

- [ ] **Auth Service**

  - User authentication and authorization with JWT

  - Role-based access control

  - User profile management

- [ ] **Auction Service**

  - Auction creation and management

  - Real-time auction status updates

  - Automatic auction completion

- [ ] **Bid Service**

  - Real-time bid processing

  - Bid validation and verification

  - Historical bid tracking

- [ ] **Payment Service**

  - Secure payment processing

  - Multiple payment method support

  - Transaction history

### 2. Technical Roadmap

- [ ] **Security**

  - JWT authentication

  - Role-based access control (RBAC)

  - API rate limiting

- [ ] **Quality Assurance**

  - Unit tests

  - Integration tests

  - Load testing

- [ ] **Documentation**

  - Development guidelines

## 6. Getting Started

Documentation coming soon...

## 7. License

This code repository is licensed under the MIT License. See [LICENSE](https://github.com/nidea1/go-gavel/blob/main/LICENSE) for more information.

## 8. Contact

If you have any questions or suggestions, feel free to reach out to me at [[email protected]](mailto:[email protected]).