github.com/iffakhry/go-commerce-mvc

Go-Commerce

About

Repository ini digunakan untuk referensi belajar membuat Rest API menggunakan Golang dengan MVC architecture. Project ini adalah project ecommerce sederhana dengan fitur manajemen data user, product dan transaksi. Project ini juga sudah dilengkapi dengan mekanisme hashing password dan JWT auth untuk security.

ERD

Tech stack

• Golang
• Echo Web Framework https://echo.labstack.com/
• Gorm ORM https://gorm.io/
• JWT Auth https://jwt.io/
• PosgreSQL
• Docker https://docker.com
• Swagger (Swaggo) https://github.com/swaggo/swag

How to run

Using Docker Compose

NB: ketika menggunakan docker compose, docker akan menjalankan aplikasi go-commerce dan database postgres secara bersamaan.

• Pastikan docker sudah terinstall

  • https://docs.docker.com/desktop/
  • https://docs.docker.com/compose/

• Jalankan Docker compose

  docker-compose up -d
  

• Stop/terminate aplikasi

  docker-compose down
  

Manual

NB: Aplikasi go-commerce membutuhkan database PostgreSQL, jadi sebelum menjalankan app, pastikan sudah terinstall di perangkat masing-masing. atau bisa juga menggunakan layanan postgresql online.

• Pastikan sudah ada database dengan nama db_commerce di PostgreSQL. (nama bisa disesuaikan dengan kebutuhan)
• Buat file .env Sesuaikan valuenya dengan konfigurasi yang ada di perangkat masing-masing.

  DBHOST=your-db-host
  DBUSER=your-db-user
  DBPASS=your-db-password
  DBNAME=your-db-name
  DBPORT=your-db-port
  JWTSECRET=your-jwt-secret
  

• Jalankan app

  go run main.go
  

API Documentation

ketika aplikasi sudah berjalan, API documentation (swagger) bisa diakses di alamat berikut: http://localhost:8080/swagger/index.html/

Install swaggo

• Download zip/tar.gz file executable swaggo dari https://github.com/swaggo/swag/releases
• extract file tersebut
• letakkan di folder tersendiri
• tambahkan ke environment path
  • macOS
    • buka nano ~/.zshrc
    • tambahkan diakhir tersendiri alias swag=~/swaggo/swag
    • note: sesuaikan dengan direktori tempat file hasil extract tadi berada

Generate swagger using swaggo

• ketika file main.go berada di root folder, maka langsung jalankan perintah:

  swag init
  

• ketika file main.go berada di subfolder, maka jalankan perintah:

  swag init -g ./cmd/httpserver/main.go -o ./docs