Experimental project using Chi and GORM

Setup database

psql
> CREATE DATABASE chi_gorm

# Be sure to update main.go with your database credentials

# install yolo - for hot reloading
go get github.com/azer/yolo

# starts development mode
make start

Structure is inspired by https://manuel.kiessling.net/2012/09/28/applying-the-clean-architecture-to-go-applications/; accepting only the principles that I like and getting rid of other notions that I deem less important.

/
|- controllers
|- config
|- dal
|- interfaces (implemented in the future)
|- lib
|- models
|- migrations
|- services
main.go
router.go

Controllers - hosts the handlers of all requests coming in. Business logic and data access layer should be done separately. This is done to decouple the system.

Config - hosts setup for the sytem to connect to external data source or any other things related to the infrastructure of the sytem. Hosts things like database connection configurations.

DAL - data access layer. All queries and data operations should happen here.

lib - arbitrary libraries that do not fit in the other directories.

Interfaces - the bridge that allows two different entities to interact with each other. For example, if the controller wants to talk to services, UserController will implement IUserService ("I" indicating interface), and in turn IUserService will be injected with UserService. This will be implemented in the future since Dependency Injection requires a lot of operations overhead.

models - contains structs reflecting our data object from database.

migrations - where the database migrations reside.

services - where the business logic should live. Handles controller requests and fetch data from data access access layer.

main.go - entry point of our system.

router.go - where we bind controllers to routes.

Database migrations are not versioned since we are going to use Gorm's AutoMigrate functionality to reduce complexity. This means that when you update the model, and you push this update to production, the database will be automatically changed. Note that this might break functionality in the case of backwards incompatible changes, and so it must be done with caution.