Merge pull request #10 from Nuxify/feature/golang-migrate

feat: go-migrate support

Makefile

@@ -1,11 +1,8 @@
+include .env
+
 # set default shell
 SHELL = bash -e -o pipefail
 
-# variables
-VERSION                  ?= $(shell cat ./VERSION)
-
-now=$(shell date +"%Y%m%d%H%M%S")
-
 default: run
 
 .PHONY:	install
@@ -36,5 +33,18 @@ up:
 	docker compose down
 	docker compose up -d --build
 
+.PHONY:	schema
+schema:
+	mkdir -p db/migration
+	migrate create -ext sql -dir db/migration -seq ${NAME}
+
+.PHONY: migrate-up
+migrate-up: 
+	migrate -path db/migration/ -database "mysql://${DB_USERNAME}:${DB_PASSWORD}@tcp(${DB_HOST}:${DB_PORT})/${DB_DATABASE}" -verbose up ${STEPS}
+
+.PHONY: migrate-down
+migrate-down:
+	migrate -path db/migration/ -database "mysql://${DB_USERNAME}:${DB_PASSWORD}@tcp(${DB_HOST}:${DB_PORT})/${DB_DATABASE}" -verbose down ${STEPS}
+
 proto-record:
 	protoc --go_out=plugins=grpc:. --go_opt=paths=source_relative module/record/interfaces/http/grpc/pb/record.proto

README.md

@@ -1,4 +1,5 @@
 # Gomora
+
 A progressive framework-agnostic API template following CLEAN architecture and SOLID principles. DDD inspired :)
 
 ## Introduction
@@ -14,35 +15,82 @@ Gomora provides the example for a module-based gRPC and REST server suitable for
 ## Local Development
 
 Setup the .env file first
-- cp .env.example .env
+
+```bash
+cp .env.example .env
+```
 
 To bootstrap everything, run:
-- make
+
+```bash
+make
+```
 
 The command above will install, build, and run the binary
 
 For manual install:
-- make install
+
+```bash
+make install
+```
 
 For lint:
-- make lint
+
+```bash
+make lint
+```
 
 Just ensure you installed golangci-lint.
 
 To test:
-- make test
+
+```bash
+make test
+```
 
 For manual build:
-- make build
-- NOTE: the output for this is in bin/
+
+```bash
+make build
+
+# The output for this is in bin/
+```
 
 ## Docker Build
 
 To build, run:
-- make run
+
+```bash
+make run
+```
 
 To run the container:
-- make up
+
+```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
+make migrate-up STEPS=<remove STEPS to apply all or specify step number>
+```
+
+To migrate down, run:
+
+```bash
+make migrate-down STEPS=<remove STEPS to apply all or specify step number>
+```
 
 ## License
 

db/migration/000001_init_schema.down.sql

@@ -0,0 +1 @@
+DROP TABLE IF EXISTS `records`;

db/migration/000001_init_schema.up.sql

@@ -0,0 +1,7 @@
+CREATE TABLE
+    `records` (
+        `id` varchar(255) NOT NULL,
+        `data` varchar(255) NOT NULL,
+        `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+        PRIMARY KEY (`id`)
+    ) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci;