docs: Update README and Makefile (#10)

.env.example

@@ -11,6 +11,9 @@ DB_PASSWORD=thisisasamplepassword
 DB_NAME=fiberdb
 DB_PORT=5432
 
+# migration golang path
+MIGRATION_PATH=~/migrate
+
 # JWT
 # JWT secret key
 JWT_SECRET=thisisasamplesecret

Makefile

@@ -1,3 +1,6 @@
+include .env
+export $(shell sed 's/=.*//' .env)
+
 start:
 	@go run src/main.go
 lint:
@@ -10,6 +13,14 @@ testsum:
 	@cd test && gotestsum --format testname
 swagger:
 	@cd src && swag init
+migrate-up:
+	@$(MIGRATE_PATH) -database "postgres://$(DB_USER):$(DB_PASSWORD)@$(DB_HOST):$(DB_PORT)/$(DB_NAME)?sslmode=disable" -path src/database/migrations up
+migrate-down:
+	@$(MIGRATE_PATH) -database "postgres://$(DB_USER):$(DB_PASSWORD)@$(DB_HOST):$(DB_PORT)/$(DB_NAME)?sslmode=disable" -path src/database/migrations down
+migrate-docker-up:
+	@docker run -v ./src/database/migrations:/migrations --network go-fiber-boilerplate_go-network migrate/migrate -path=/migrations/ -database postgres://$(DB_USER):$(DB_PASSWORD)@$(DB_HOST):$(DB_PORT)/$(DB_NAME)?sslmode=disable up
+migrate-docker-down:
+	@docker run -v ./src/database/migrations:/migrations --network go-fiber-boilerplate_go-network migrate/migrate -path=/migrations/ -database postgres://$(DB_USER):$(DB_PASSWORD)@$(DB_HOST):$(DB_PORT)/$(DB_NAME)?sslmode=disable down -all
 docker:
 	@docker-compose up --build
 docker-test:

README.md

@@ -77,6 +77,7 @@ cp .env.example .env
 - **Compression**: gzip compression with [Fiber-Compress](https://docs.gofiber.io/api/middleware/compress)
 - **Docker support**
 - **Linting**: with [golangci-lint](https://golangci-lint.run)
+- **Migrations**: with [golang-migrate](https://github.com/golang-migrate/migrate)
 
 ## Commands
 
@@ -133,6 +134,22 @@ Swagger:
 make swagger
 ```
 
+Migration:
+
+```bash
+# run migration up in local
+make migrate-up
+
+# run migration down in local
+make migrate-down
+
+# run migration up in docker container
+make migrate-docker-up
+
+# run migration down all in docker container
+make migrate-docker-down-all
+```
+
 ## Environment Variables
 
 The environment variables can be found and modified in the `.env` file. They come with these default values: