Research Modular Architecture Using Golang

This project is example research for how building modular architecture in Golang.

Table of Contents

List of all readme contents:

• Key Features
• Built With
• Deployment
• API Reference
• Release History
• Authors

Key Features

List of all features/functionalities handled by this app/service:

• Key feature A
  • Sub feature A1
  • Sub feature A2
  • Sub feature A3
• Key feature B
  • Sub feature B1
  • Sub feature B2
• Key feature C
• Key feature D
• Key feature E

Built With

List of all core technologies used to build this app/service along with their functions, versions (if any), and link to their online pages, grouped based on development stack:

Backend

• Golang - Programming Language [v1.12.4]
• Gin Gonic - HTTP Routing Framework for Golang [v1.3.0]
• Echo - HTTP Routing Framework for Golang [v4.0.0]
• Dep Package Management - Dep Package Management For Golang [v0.5.1]
• Viper Configuration Tools - Viper Configuration Tools [v1.3.2]
• Go SQL Driver - SQL Driver For MySQL DB [v1.4.1]
• Assert Unit Testing - Assert Testify Unit Test Tools [v1.3.0]

Frontend

• Angular - JS Framework [v.7.0.0]
• Bootstrap - CSS Framework [v4.0.0]

Automation Test

• For Running All Test, run command go test

Database

• MySQL - Core Database [v5.7]

Deployment

List all required steps to deploy this app/service in server, like environment variables, server requirements, amount of compute resources (CPU, RAM), and dependency services that will communicate with this app/service.

Environment Variables

MySQL Config:

• MYSQL_DATABASE Name of the database using MySQL.
• MYSQL_USER Username for the database using MySQL.
• MYSQL_PASSWORD Password for the database using MySQL.
• MYSQL_HOST Hostname of the database server using MySQL.

Dependency Services Config:

• USER_SERVICE FQDN of User Service.
• STUDENT_SERVICE FQDN of Student Service.
• NOTIF_SERVICE FQDN of Notification Service.
• LOGGING_SERVICE FQDN of Logging Service.

Other Config:

• LOG_LEVEL Log level of the service. Accepted values: debug, info, or notice.
• JWT_SECRET The key that will be used to sign JSON Web Token.

API Reference

Depending on the size of this app/service APIs, if it is small and simple enough the reference docs can be added to this README. For medium to larger app/service please use Gitlab wiki or provide a link to where the API reference docs live.

Release History

List of all released versions of this app/service along with their version logs, sorted from newest to oldest:

• 0.2.1
  • CHANGE: Update docs (module code remains unchanged)
• 0.2.0
  • CHANGE: Remove setDefaultXYZ()
  • ADD: Add init()
• 0.1.1
  • FIX: Crash when calling baz()
• 0.1.0
  • The first proper release
  • CHANGE: rename foo() to bar()
• 0.0.1
  • Work in progress

Authors

List of all people working on this app/service along with their respective roles & contact emails:

• Reja Nur Rochmat - Fullstack Engineer