sockshop

README

Sock Shop

A Golang demo web application. It is intended to aid the demonstration of how to write a web application in Golang using SOLID principles. This is a rewrite of https://github.dev/microservices-demo/ to demonstrate how to write a Golang web app following SOLID and idiomatic Go principles.

Overview

The application is structured to separate concerns and provide a clear separation between the different layers of the application.

Package Layout

.
├── LICENSE
├── Makefile
├── README.md
├── api
│   ├── address.go
│   ├── cards.go
│   ├── errors.go
│   ├── health.go
│   ├── httpkit
│   │   └── http_kit.go
│   ├── links.go
│   ├── middleware
│   │   ├── log.go
│   │   └── metrics.go
│   ├── router
│   │   ├── catalogue
│   │   │   ├── catalogue.go
│   │   │   └── routes.go
│   │   ├── router.go
│   │   └── user
│   │       ├── routes.go
│   │       └── user.go
│   ├── server.go
│   ├── socks.go
│   └── users.go
├── assets
├── bin
├── cmd
│   └── sockshop
│       ├── config.go
│       └── main.go
├── deploy
│   └── docker
│       └── sockshop-db
│           └── catalogue_dump.sql
├── docker-compose.yml
├── go.mod
├── go.sum
├── godepgraph.png
└── internal
    ├── app
    │   ├── catalogue.go
    │   └── users.go
    ├── db
    │   ├── db.go
    │   └── mysql
    │       ├── socks.go
    │       ├── sqlx.go
    │       └── users.go
    └── domain
        ├── errors.go
        ├── socks.go
        └── users.go

Description

/api

api package should only contain the request and response schema. It should not have any application logic or dependency. Additionally It can also contain interface definitions. Which can use the defined request and respose schema as input/output parmas in the interface methods. It should not contain any concrete type which implements those interface. This will provide an abstraction to your business logic.

/api/router

Contains all HTTP routes for the application. All routes implement the Router interface defined in api/router.go.

See /api package for example.

/cmd

This will contain the main package(s) for this project. The directory name for each application in cmd should match the name of executable you want. You should not put a lot of code in main package. You should only initialize the app dependencies in here and inject it to higher level modules/components.

See /cmd package for example.

/internal

This package should provide the private application code. It should define the concrete types having methods with actual business logic. Your application code can go in the /internal/app packgae. It will contain concrete types which can implement intefaces defined in /api package.

You can define packages like internal/db, internal/<api-client> ..etc. Which will define concrete types implementing interfaces defined in /domain package.

See /internal package for example.

/internal/domain

domain package should only contain your application domain related information. It should define the application domain types and related interfaces. You should not put any concreate implementaion in here. This is an abstraction to your application domain. The actual implementation could be catered using a database or a third party API. Application domain should be independent of the actual concrete implementation.

See /internal/domain package for example.

Dependency graph

Generated using github.com/kisielk/godepgraph

Usage

Run the application using make run and to stop the application run make clean