https://github.com/d3ta-go/ms-email-restapi
MicroService Interface/Presentation App: Email RestAPI
https://github.com/d3ta-go/ms-email-restapi
ddd ddd-architecture interface-layer microservice rest-api
Last synced: 3 months ago
JSON representation
MicroService Interface/Presentation App: Email RestAPI
- Host: GitHub
- URL: https://github.com/d3ta-go/ms-email-restapi
- Owner: d3ta-go
- License: mit
- Created: 2020-11-12T08:23:12.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-09-30T20:32:30.000Z (over 3 years ago)
- Last Synced: 2024-06-20T05:11:53.103Z (almost 2 years ago)
- Topics: ddd, ddd-architecture, interface-layer, microservice, rest-api
- Language: Go
- Homepage:
- Size: 3.86 MB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ms-email-restapi ( [](https://goreportcard.com/report/github.com/d3ta-go/ms-email-restapi) )
MicroService Interface/Presentation App: Email RestAPI
As a part of `Simple Implementation of Modular DDD Technical Architecture Patterns in Go`.
## Diagram v 0.2.2-Modular
## Components
A. Interface Layer (MicroService)
1. Microservice: Email REST API - using Echo Framework [ [d3ta-go/ms-email-restapi](https://github.com/d3ta-go/ms-email-restapi) ]
B. DDD Modules:
1. Email - using DDD Layered Architecture (Contract, GORM, SMTP) [ [d3ta-go/ddd-mod-email](https://github.com/d3ta-go/ddd-mod-email) ]
C. Common System Libraries [ [d3ta-go/system](https://github.com/d3ta-go/system) ]:
1. Configuration - using yaml
2. Identity & Securities - using JWT, Casbin (RBAC)
3. Initializer
4. Email Sender - using SMTP
5. Handler
6. Migrations
7. Utils
D. Databases
1. MySQL (tested)
2. PostgreSQL (untested)
3. SQLServer (untested)
4. SQLite3 (untested)
E. Persistent Caches
1. Session/Token/JWT Cache (Redis, File, DB, etc) [tested: Redis]
F. Messaging [to-do]
G. Logs [to-do]
### Development
1. Clone
```shell
$ git clone https://github.com/d3ta-go/ms-email-restapi.git
```
2. Setup
```
a. copy `conf/config-sample.yaml` to `conf/config.yaml`
b. copy `conf/data/test-data-sample.yaml` to `conf/data/test-data.yaml`
c. setup your dependencies/requirements (e.g: database, redis, smtp, etc.)
```
3. Runing on Development Stage
```shell
$ cd ms-email-restapi
$ go run main.go db migrate
$ go run main.go server restapi
```
4. Build
```shell
$ cd ms-email-restapi
$ go build
$ ./ms-email-restapi db migrate
$ ./ms-email-restapi server restapi
```
5. Distribution (binary)
Binary distribution (OS/arch):
- darwin/amd64
- linux/amd64
- linux/386
- windows/amd64
- windows/386
```shell
$ cd ms-email-restapi
$ sh build.dist.sh
$ platform: [choose from OS/arch list, for example: darwin/amd64]
$ cd dist/[OS-arch]/
$ ./ms-email-restapi db migrate
$ ./ms-email-restapi server restapi
```
**RESTAPI (console):**
**Swagger UI (openapis docs):**
URL: http://localhost:20201/openapis/docs/index.html
**Related Domain/Repositories:**
1. DDD Module: Email (Generic Subdomain) - [d3ta-go/ddd-mod-email](https://github.com/d3ta-go/ddd-mod-email)
2. Common System Libraries - [d3ta-go/system](https://github.com/d3ta-go/system)
3. Need JWT Authorization/Token from: Account (Generic Subdomain) Module/Account REST API - [d3ta-go/ms-account-restapi](https://github.com/d3ta-go/ms-account-restapi). `Please use shared redis server to store/retrieve JWT Token.`
4. Email GraphQL API Microservice - [d3ta-go/ms-email-graphql-api](https://github.com/d3ta-go/ms-email-graphql-api)
**Online Demo:\***
> URL: **https://ms-email-d3tago-demo.mhs.web.id/openapis/docs/index.html**
For demo user account please grab it via: [**d3ta-go/ms-account-restapi**](https://github.com/d3ta-go/ms-account-restapi)
**References:**
1. [Book] Domain-Driven Design: Tackling Complexity in the Heart of Software 1st Edition (Eric Evans, 2004)
2. [Book] Patterns, Principles, and Practices of Domain-Driven Design (Scott Millett & Nick Tune, 2015)
**Team & Maintainer:**
1. Muhammad Hari (https://www.linkedin.com/in/muharihar/)