Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moemoe89/go-clean-arch-ratu
💕 Simple Go Clean Arch by Uncle Bob with MariaDB for database
https://github.com/moemoe89/go-clean-arch-ratu
clean-architecture codecov docker gin go golang goose mariadb rest-api swagger travis-ci uncle-bob
Last synced: about 1 month ago
JSON representation
💕 Simple Go Clean Arch by Uncle Bob with MariaDB for database
- Host: GitHub
- URL: https://github.com/moemoe89/go-clean-arch-ratu
- Owner: moemoe89
- License: mit
- Created: 2020-02-03T09:56:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-14T16:06:49.000Z (over 4 years ago)
- Last Synced: 2024-11-15T21:45:55.264Z (about 1 month ago)
- Topics: clean-architecture, codecov, docker, gin, go, golang, goose, mariadb, rest-api, swagger, travis-ci, uncle-bob
- Language: Go
- Homepage:
- Size: 18.8 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/moemoe89/go-clean-arch-ratu)
[](https://codecov.io/gh/moemoe89/go-clean-arch-ratu)
[](https://goreportcard.com/report/github.com/moemoe89/go-clean-arch-ratu)
# GO-CLEAN-ARCH-RATU #
Simple Go Clean Arch Using Golang (Gin Gonic Framework) as Programming Language, MariaDB as Database
## Directory structure
Your project directory structure should look like this
```
+ your_gopath/
|
+--+ src/github.com/moemoe89
| |
| +--+ go-clean-arch-ratu/
| |
| +--+ main.go
| + api/
| + routers/
| + ... any other source code
|
+--+ bin/
| |
| +-- ... executable file
|
+--+ pkg/
|
+-- ... all dependency_library required
```
## Setup and Build
* Setup Golang
* Setup MariaDB
* Under `$GOPATH`, do the following command :
```
$ mkdir -p src/github.com/moemoe89
$ cd src/github.com/moemoe89
$ git clone
$ mv go-clean-arch-ratu
```
## Running Migration
* Copy `config-sample.json` to `config.json` and changes the value based on your configurations.
* Create MySQL database for example named `simple_api` and do migration with `Goose`
* Change database configuration on dbconf.yml like `dialect` and `dsn` for each environtment
* Do the following command
```
$ cd $GOPATH/src/github.com/moemoe89/go-clean-arch-ratu
$ goose -env=development up
```
## Documetation with Swagger
For open swagger access via browser
```
{{url}}/swagger/index.html
```
For updating swagger
```
$ swag init
```
## Running Application with Makefile
Make config file for local :
```
$ cp config-sample.json config-local.json
```
Build
```
$ cd $GOPATH/src/github.com/moemoe89/go-clean-arch-ratu
$ make build
```
Run
```
$ cd $GOPATH/src/github.com/moemoe89/go-clean-arch-ratu
$ make run
```
Stop
```
$ cd $GOPATH/src/github.com/moemoe89/go-clean-arch-ratu
$ make stop
```
Make config file for docker :
```
$ cp config-sample.json config-docker.json
```
Docker Build
```
$ cd $GOPATH/src/github.com/moemoe89/go-clean-arch-ratu
$ make docker-build
```
Docker Up
```
$ cd $GOPATH/src/github.com/moemoe89/go-clean-arch-ratu
$ make docker-up
```
Docker Down
```
$ cd $GOPATH/src/github.com/moemoe89/go-clean-arch-ratu
$ make docker-down
```
## How to Run with Docker
Make config file for docker :
```
$ cp config-sample.json config.json
```
Build
```
$ docker-compose build
```
Run
```
$ docker-compose up
```
Stop
```
$ docker-compose down
```
## How to Run Unit Test
Run
```
$ go test ./...
```
Run with cover
```
$ go test ./... -cover
```
Run with HTML output
```
$ go test ./... -coverprofile=c.out && go tool cover -html=c.out
```
## Reference
Thanks to this medium [link](https://medium.com/golangid/mencoba-golang-clean-architecture-c2462f355f41) for sharing the great article
## License
MIT