https://github.com/quocanh189/mini_ecommerce_clean

E-Commerce mini system via Golang with Clean Architechture
https://github.com/quocanh189/mini_ecommerce_clean

clean-architecture docker gin-gonic golang grafana jwt minio nginx postgresql prometheus react redis swagger

Last synced: about 1 year ago
JSON representation

E-Commerce mini system via Golang with Clean Architechture

• Host: GitHub
• URL: https://github.com/quocanh189/mini_ecommerce_clean
• Owner: QuocAnh189
• License: mit
• Created: 2025-03-20T14:35:59.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-08T08:43:19.000Z (about 1 year ago)
• Last Synced: 2025-04-08T09:23:52.883Z (about 1 year ago)
• Topics: clean-architecture, docker, gin-gonic, golang, grafana, jwt, minio, nginx, postgresql, prometheus, react, redis, swagger
• Language: Go
• Homepage:
• Size: 24.1 MB
• Stars: 19
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Go-Ecommerce-Clean Architecture](docs/static/main.excalidraw.svg)

# Go-Ecommerce-Clean Architecture

## ⭐⭐⭐ Give Me Star

If this project is helpful to you, please consider giving it a star on GitHub. Contact with me if you have a question.

## Overview

The purpose of the template is to show:

- how to organize a project and prevent it from turning into spaghetti code

- where to store business logic so that it remains independent, clean, and extensible

- how not to lose control when a project grows

Using the principles of Robert Martin (aka Uncle Bob).

## Demo (Youtube)

[![Watch the demo](docs/static/screeen.png)](https://www.youtube.com/watch?v=v5L2c1o0I7M)

## Clean Architecture

![Clean](docs/static/clean.excalidraw.svg)

## Database

![Database](docs/static/database.png)

## Clean Module

### User_Module

![UserModel](docs/static/user_module.excalidraw.svg)

### Product_Module

![ProductModule](docs/static/product_module.excalidraw.svg)

### Order_Module

![OrderModule](docs/static/order_module.excalidraw.svg)

### Cart_Module

![OrderModule](docs/static/cart_module.excalidraw.svg)

## Tech Stack

![TechStack](docs/static/techstack.excalidraw.svg)

- [React](https://react.dev)

- [Restful API](https://docs.github.com/en/rest?apiVersion=2022-11-28)

- [Domain Driven Design](https://flowframework.readthedocs.io/en/stable/TheDefinitiveGuide/PartI/ConceptsOfModernProgramming.html)

- [Gin-gonic](https://github.com/gin-gonic/gin)

- [Gorm](https://github.com/go-gorm/gorm)

- [Swagger](https://github.com/swagger-api)

- [Logging](https://github.com/uber-go/zap)

- [Jwt-Go](https://github.com/golang-jwt/jwt)

- [Casbin](https://github.com/casbin/casbin)

- [Redis](https://github.com/redis/go-redis)

- [Minio](https://github.com/minio/minio-go)

- [Docker](https://www.docker.com/)

- [Nginx](https://nginx.org/)

- [Grafana](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/integration-reference/integration-golang/)

- [Prometheus](https://github.com/prometheus/client_golang)

## Project Structure

![Project_Structure](docs/static/project_structure.excalidraw.svg)

### `cmd/app`

Entry point of the application. Responsible for initializing the configuration, setting up the logger, and starting the application.

### `configs`

Contains configuration files for different environments, such as database connections, API keys, and other application settings.

### `db`

Holds database-related files, including database setup and option function.

### `frontend`

Setup client for demo project.

### `docs`

Contains documentation files, API specifications, and related documentation resources.

### `internals`

This directory houses the core business logic of the application, divided into multiples modules

### `nginx`

Stores configuration files for Nginx

### `pkgs`

Contains reusable packages and utilities that can be shared across different parts of the project.

### `utils`

Includes utility functions and helper methods used throughout the project.

### `grafana`

Contains configuration files and dashboards for monitoring application metrics using Grafana.

### `prometheus`

Holds configuration files for Prometheus, which collects and stores metrics from the application for monitoring and alerting.

## How to run application (Docker)

1. Clone the repo and cd into it

2. Set mode `LF` (not `CRLF`) for entrypoint.sh file

3. Run `docker-compose up --build -d` local dev environment

4. Setup minio container.

- Run `docker exect -it  sh`.

- Run `mc alias set myminio http://ecommerce.minio:9000 minioadmin minioadmin123`.

- Run `mc anonymous set public myminio/ecommerce`.

5. Test api with BASE_URL is `http://localhost:8080/api/v1` or `http://app.lvh.me/api/v1`

6. If you want to demo with frontend on React, visit `http://localhost:8005` on browser.

## Reference projects

- [https://github.com/evrone/go-clean-template](https://github.com/evrone/go-clean-template)

- [https://github.com/bxcodec/go-clean-arch](https://github.com/bxcodec/go-clean-arch)

## Useful links

- [The Clean Architecture article](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)

- [Twelve factors](https://12factor.net/ru/)

## Author Contact

Contact me with any questions!


Email: anquoc18092003@gmail.com

Facebook: https://www.facebook.com/tranphuocanhquoc2003

Thank You so much for your time !!!