Backend Overview

This section content all information about trevelin Backend.

Current Condition

Now our backend uses monolithic architecture, because we are pursuing product MVP for release first.

Project Structure

Code
 
├── cmd
├── config
├── container
├── contract.json
├── db
├── docker-compose.dev.yaml
├── docker-compose.yaml
├── Dockerfile
├── Dockerfile.dev
├── docs
├── external
├── go.mod
├── go.sum
├── internal
├── main
├── Makefile
├── pkg
└── README.md

• cmd is entry point, containt main package
• config is folder containt configuration
• container is package for dependencies injection, currently we use uber dig for dependencies injection.
• db this folder containt all migration files
• docs this folder containt all docs if needed
• external this folder containt all external package, such as xendit.
• internal this folder containt all internal trevelin usecases.
• pkg this folder containt utility for this app

How to run

like the regular golang programming language, we can run with this command

Code
 
go run cmd/api/main.go

or you can run with docker-compose.dev.yaml, this will run the db, jaeger, and trevelin backend applications itself