Initial commit

Author: kabaluyot

.dockerignore

@@ -0,0 +1,4 @@
+vendor
+bin
+Dockerfile
+.dockerignore

.env.example

@@ -0,0 +1,15 @@
+API_NAME=gomora
+API_ENV=local
+API_URL_GRPC=http://localhost
+API_URL_GRPC_PORT=9090
+API_URL_REST=http://localhost
+API_URL_REST_PORT=8000
+API_VERSION=v1.4.0
+
+DB_HOST=localhost
+DB_PORT=3306
+DB_DATABASE=
+DB_USERNAME=
+DB_PASSWORD=
+
+OPENAPI_DOCS_PASSWORD=

.gitignore

@@ -0,0 +1,25 @@
+# Binaries for programs and plugins
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
+.glide/
+
+#directories
+.idea/
+.vscode/
+vendor/
+
+#single files
+.env
+
+#executable files
+bin

Dockerfile

@@ -0,0 +1,12 @@
+FROM golang:1.21
+
+ENV GO111MODULE=on
+
+WORKDIR /app/build
+COPY go.mod .
+COPY go.sum .
+
+RUN go mod download
+COPY . .
+
+CMD ["make", "run"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Karl Anthony B. Baluyot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,68 @@
+include .env
+
+# set default shell
+SHELL = bash -e -o pipefail
+
+default: run-dev
+
+.PHONY:	install
+install:
+	go mod tidy
+	go mod vendor
+
+.PHONY:	lint
+lint:
+	golangci-lint run 
+
+.PHONY:	build
+build:
+	mkdir -p bin
+	go build -o bin/gomora \
+	    cmd/main.go
+
+.PHONY:	build-dev
+build-dev:
+	mkdir -p bin
+	go build -race -o bin/gomora \
+	    cmd/main.go
+
+.PHONY:	test
+test:
+	go test -race -v -p 1 ./...
+	
+.PHONY:	run
+run:	build
+	./bin/gomora
+
+.PHONY:	run-dev
+run-dev:	build-dev
+	./bin/gomora
+
+.PHONY: up
+up:
+	docker compose down
+	docker compose up -d --build
+
+.PHONY:	schema
+schema:
+	mkdir -p infrastructures/database/mysql/migrations
+	migrate create -ext sql -dir infrastructures/database/mysql/migrations -seq ${NAME}
+
+.PHONY: migrate-up
+migrate-up: 
+	migrate -path infrastructures/database/mysql/migrations -database "mysql://${DB_USERNAME}:${DB_PASSWORD}@tcp(${DB_HOST}:${DB_PORT})/${DB_DATABASE}" -verbose up ${STEPS}
+
+.PHONY: migrate-down
+migrate-down:
+	migrate -path infrastructures/database/mysql/migrations -database "mysql://${DB_USERNAME}:${DB_PASSWORD}@tcp(${DB_HOST}:${DB_PORT})/${DB_DATABASE}" -verbose down ${STEPS}
+
+.PHONY: migrate-version
+migrate-version:
+	migrate -path infrastructures/database/mysql/migrations -database "mysql://${DB_USERNAME}:${DB_PASSWORD}@tcp(${DB_HOST}:${DB_PORT})/${DB_DATABASE}" version
+
+.PHONY: migrate-force
+migrate-force:
+	migrate -path infrastructures/database/mysql/migrations -database "mysql://${DB_USERNAME}:${DB_PASSWORD}@tcp(${DB_HOST}:${DB_PORT})/${DB_DATABASE}" force ${STEPS}
+
+proto-record:
+	protoc --go_out=plugins=grpc:. --go_opt=paths=source_relative module/record/interfaces/http/grpc/pb/record.proto

README.md

@@ -0,0 +1,113 @@
+# Gomora
+
+A progressive framework-agnostic API template following CLEAN architecture and SOLID principles. DDD inspired :)
+
+## Introduction
+
+Gomora provides the example for a module-based gRPC and REST server suitable for building progressive APIs (from monolith to distributed microservices).
+
+<img width="1416" alt="Screen Shot 2024-10-07 at 9 43 31 AM" src="https://github.com/user-attachments/assets/736b9813-f086-4fd4-aeb3-98e08df51e7e">
+
+<img width="1416" alt="Screen Shot 2024-10-07 at 9 41 10 AM" src="https://github.com/user-attachments/assets/0225919b-53d1-4900-9b9e-8d5d5f616d73">
+
+<img width="1416" alt="Screen Shot 2024-10-07 at 9 44 17 AM" src="https://github.com/user-attachments/assets/a5871a22-be66-4236-8635-6166624249c1">
+
+<img width="1416" alt="Screen Shot 2024-10-07 at 9 46 05 AM" src="https://github.com/user-attachments/assets/578de61d-73cb-47b9-8806-ed58a7b281a1">
+
+## Local Development
+
+Setup the .env file first
+
+```bash
+cp .env.example .env
+```
+
+To bootstrap everything, run:
+
+```bash
+make
+```
+
+The command above will install, build, and run the binary
+
+For manual install:
+
+```bash
+make install
+```
+
+For lint:
+
+```bash
+make lint
+```
+
+Just ensure you installed golangci-lint.
+
+To test:
+
+```bash
+make test
+```
+
+For manual build:
+
+```bash
+make build
+
+# The output for this is in bin/
+```
+
+## Docker Build
+
+To build, run:
+
+```bash
+make run
+```
+
+To run the container:
+
+```bash
+make up
+```
+
+## Database Migration
+
+Gomora uses go-migrate (https://github.com/golang-migrate/migrate) to handle migration. Download and change your migrate database command accordingly.
+
+To create a schema, run:
+
+```bash
+make schema NAME=<init_schema>
+```
+
+To migrate up, run:
+
+```bash
+STEPS=<remove STEPS to apply all or specify step number> make migrate-up
+```
+
+To migrate down, run:
+
+```bash
+STEPS=<remove STEPS to apply all or specify step number> make migrate-down
+```
+
+To check migrate version, run:
+
+```bash
+make migrate-version
+```
+
+To force migrate, run:
+
+```bash
+STEPS=<specify step number> make migrate-force
+```
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+
+Made with ❤️ at [Nuxify](https://nuxify.tech)

cmd/.gitignore

@@ -0,0 +1 @@
+cmd

cmd/main.go

@@ -0,0 +1,55 @@
+/*
+|--------------------------------------------------------------------------
+| Main
+|--------------------------------------------------------------------------
+|
+| This is the entry point for listeners of the project.
+| You can create and run goroutines for event listeners below before the HTTP listener.
+|
+*/
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"strconv"
+
+	"github.com/joho/godotenv"
+
+	"gomora/interfaces/http/grpc"
+	"gomora/interfaces/http/rest"
+)
+
+func init() {
+	// load our environmental variables.
+	if err := godotenv.Load(); err != nil {
+		panic(err)
+	}
+}
+
+func main() {
+	// grpc port
+	grpcPort, err := strconv.Atoi(os.Getenv("API_URL_GRPC_PORT"))
+	if err != nil {
+		log.Fatalf("[SERVER] Invalid port")
+	}
+	if len(fmt.Sprintf("%d", grpcPort)) == 0 {
+		grpcPort = 9090 // default grpcPort is 9090 if not set
+	}
+
+	// rest port
+	restPort, err := strconv.Atoi(os.Getenv("API_URL_REST_PORT"))
+	if err != nil {
+		log.Fatalf("[SERVER] Invalid port")
+	}
+	if len(fmt.Sprintf("%d", restPort)) == 0 {
+		restPort = 8000 // default grpcPort is 8000 if not set
+	}
+
+	// serve rest server
+	go rest.ChiRouter().Serve(restPort)
+
+	// serve grpc server
+	grpc.GRPCServer().Serve(grpcPort)
+}

configs/cors/cors.go

@@ -0,0 +1,46 @@
+package cors
+
+// Config holds the CORS configurations
+type Config struct{}
+
+// AllowCredentials return a boolean expression whether credentials are allowed
+func (c *Config) AllowCredentials() bool {
+	return true
+}
+
+// AllowedHeaders returns list of allowed headers
+func (c *Config) AllowedHeaders() []string {
+	return []string{
+		"Accept",
+		"Authorization",
+		"Content-Type",
+		"X-CSRF-Token",
+	}
+}
+
+// AllowedOrigins returns list of allowed origins
+func (c *Config) AllowedOrigins() []string {
+	return []string{"*"}
+}
+
+// AllowedMethods returns list of allowed methods
+func (c *Config) AllowedMethods() []string {
+	return []string{
+		"GET",
+		"POST",
+		"PUT",
+		"PATCH",
+		"DELETE",
+		"OPTIONS",
+	}
+}
+
+// ExposedHeaders returns list of exposed headers
+func (c *Config) ExposedHeaders() []string {
+	return []string{"Link"}
+}
+
+// MaxAge returns the maximum number of age in browser in seconds
+func (c *Config) MaxAge() int {
+	return 300
+}

configs/hystrix/hystrix.go

@@ -0,0 +1,15 @@
+package hystrix
+
+import (
+	"github.com/afex/hystrix-go/hystrix"
+)
+
+// Config handles the hystrix configurations
+type Config struct{}
+
+// Settings returns the hystrix command config
+func (c Config) Settings() hystrix.CommandConfig {
+	return hystrix.CommandConfig{
+		Timeout: 3000,
+	}
+}