stoqu-be

Stoqu Backend Service With Clean Architecture

HOST : http://localhost:3000

Pre Requisite

Go version 1.19

How To Run

# setup db
$ docker compose -f deployments/docker/docker-compose.yml up -d

# setup swagger 
$ go install github.com/swaggo/swag/cmd/swag@latest
$ swag init --propertyStrategy snakecase

# mod
$ go mod tidy

# run 
$ ENV=local go run main.go

# open
$ Open url http://localhost:3000/swagger/index.html

Architecture

This project built in clean architecture that contains some layer :

Driver
Factory
Delivery
Repository
Usecase
Model

Packages

This project have some existing driver :

Http (rest, ws, web)
Database (postgres, mysql)
Elasticsearch
Firebase
Sentry
Websocket
Cron

Documentation

Install environment

# get swagger package 
$ go install github.com/swaggo/swag/cmd/swag@latest

# generate swagger doc
$ swag init --propertyStrategy snakecase

to see the results, run app and access {{url}}/swagger/index.html

Author

Stoqu Team