Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/febrihidayan/go-architecture-monorepo
Go (Golang) Clean Architecture to Start Project Based
https://github.com/febrihidayan/go-architecture-monorepo
clean-architecture go-microservice golang golang-library golang-package grpc krakend microservices monorepo web-api
Last synced: 4 days ago
JSON representation
Go (Golang) Clean Architecture to Start Project Based
- Host: GitHub
- URL: https://github.com/febrihidayan/go-architecture-monorepo
- Owner: febrihidayan
- License: mit
- Created: 2022-10-02T16:56:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T13:21:08.000Z (10 days ago)
- Last Synced: 2024-09-26T04:31:22.413Z (8 days ago)
- Topics: clean-architecture, go-microservice, golang, golang-library, golang-package, grpc, krakend, microservices, monorepo, web-api
- Language: Go
- Homepage:
- Size: 308 KB
- Stars: 77
- Watchers: 2
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go Architecture Monorepo
Started rest API with clean architecture monorepo golang
**Table of Contents**
- [Go Architecture Monorepo](#go-architecture-monorepo)
- [Required](#required)
- [Installation](#installation)
- [With Docker](#with-docker)
- [Port HTTP and RPC Services](#port-http-and-rpc-services)
- [Docs Services](#docs-services)
- [Notification Service](#notification-service)
## Required
1. [Golang](https://go.dev/) v1.21.5 or above
2. [MongoDB](https://www.mongodb.com/)
3. [Buf](https://docs.buf.build/) to generate protobuf grpc
## Installation
1. copy environment by services `cp .env.example .env`
2. sync go modules `go mod tidy`
3. Run `sh run-service.sh service-name`
## With Docker
1. Build for all services `docker-compose build`
2. Run docker `docker-compose up -d`
3. See docker running `docker ps`
## Port HTTP and RPC Services
| Service Name | Port HTTP | Port RPC |
| :----------- | :-------- | :------- |
| auth | 8083 | 9083 |
| user | 8084 | 9084 |
| storage | 8085 | 9085 |
| notification | 8086 | 9086 |
## Docs Services
Here I will provide the information that the service needs to set some default configurations.
You can see all endpoints at the following link: [Endpoints Go Architecture Monorepo](https://www.postman.com/bold-trinity-430312/workspace/go-architecture-monorepo)
### Notification Service
In the notification service you must save templates for email and FCM needs, here I will provide an example payload to save to the database. You can modify as you wish, you need to know that the use of email and FCM templates must be different. If they are the same then the concept of both should be the same as the welcome template.
**Welcome**:
```json
{
"name": "welcome",
"data": {
"title": {
"id": "Selamat Datang",
"en": "Welcome"
},
"body": {
"id": "Hai {{.name}}, kamu telah menjadi bagian dari kami.",
"en": "Hi {{.name}}, you have become one of us."
}
}
}
```
**Email Verified**:
```json
{
"name": "email-verified",
"data": {
"title": {
"id": "Pemberitahuan Reset Kata Sandi",
"en": "Reset Password Notification"
},
"link": {
"id": "{{.link}}",
"en": "{{.link}}"
}
}
}
```
**Password Reset**:
```json
{
"name": "password-reset",
"data": {
"title": {
"id": "Pemberitahuan Reset Kata Sandi",
"en": "Reset Password Notification"
},
"link": {
"id": "{{.link}}",
"en": "{{.link}}"
},
"expire": {
"id": "{{.expire}}",
"en": "{{.expire}}"
}
}
}
```
> You can add templates via endpoint `/v1/notification/template`.