Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quangdangfit/goshop

E-Commerce backend system via Golang and Postgres
https://github.com/quangdangfit/goshop

ddd domain-driven-design ecommerce gin golang gprc postgresql redis restful swagger

Last synced: 3 days ago
JSON representation

E-Commerce backend system via Golang and Postgres

Host: GitHub
URL: https://github.com/quangdangfit/goshop
Owner: quangdangfit
License: mit
Created: 2020-07-20T03:29:06.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-06-30T12:57:40.000Z (6 months ago)
Last Synced: 2024-12-18T22:02:19.203Z (4 days ago)
Topics: ddd, domain-driven-design, ecommerce, gin, golang, gprc, postgresql, redis, restful, swagger
Language: Go
Homepage:
Size: 437 KB
Stars: 237
Watchers: 3
Forks: 55
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Go Shop
[![Master](https://github.com/quangdangfit/goshop/workflows/master/badge.svg)](https://github.com/quangdangfit/goshop/actions)
[![codecov](https://codecov.io/gh/quangdangfit/goshop/graph/badge.svg?token=78BO8FQDB0)](https://codecov.io/gh/quangdangfit/goshop)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/quangdangfit/goshop?style=flat-square)
[![GitHub](https://img.shields.io/github/license/jrapoport/gothic?style=flat-square)](https://github.com/quangdangfit/goshop/blob/master/LICENSE)

An example of gin contains many useful features for e-commerce websites

## How to run

### Required Environment

- Postgres
- Redis

You can see the docker compose file [here](https://github.com/quangdangfit/docker-compose-template/blob/master/base/docker-compose.yml) to set up required environment

### Config
- Copy config file: `cp pkg/config/config.sample.yaml pkg/config/config.yaml`
- You should modify `pkg/config/config.yaml`

```yaml
environment: production
http_port: 8888
grpc_port: 8889
auth_secret: ######
database_uri: postgres://username:password@host:5432/database
redis_uri: localhost:6379
redis_password:
redis_db: 0
```

### Run
```shell script
$ go run cmd/api/main.go
```
```
2023-09-12T15:18:36.684+0700 INFO http/server.go:58 HTTP server is listening on PORT: 8888
2023-09-12T15:18:36.684+0700 INFO grpc/server.go:53 GRPC server is listening on PORT: 8889
```

### Test
```shell script
$ go test
```

### Test with Coverage
```shell script
go test -timeout 9000s -a -v -coverprofile=coverage.out -coverpkg=./... ./...
```

**or**

```shell script
make unittest
```

### Document
* API document at: `http://localhost:8888/swagger/index.html`

### Tech stack
- Restful API
- GRPC
- DDD
- Gorm
- Swagger
- Logging
- Jwt-Go
- Gin-gonic
- Redis

### What's next?
- gRPC functions for products and orders
- Push message to notify place order successfully
- Payment with PayPal
- Define error response wrapper

### Donate:
- Ethereum: `0x96b2F7E87786Db12121D66477e87539619aa2c97`
- BNB Chain: `0x96b2F7E87786Db12121D66477e87539619aa2c97`