CIMOL

Notification Service

Cimol using AWS Kinesis data streaming system and dynamo to logging all history log

Getting Started

This support For go version 1.13

Documentation

Local Development

Fork this repo for your repo then clone in your local

git clone https://github.com/sofyan48/cimol.git

Get Project Moduls

go get github.com/sofyan48/cimol

Environment Setup

For Development Mode Setup dotenv

cp .env.example .env

Setting up your local configuration see example

####################################################################
# SERVER CONFIGURATION
####################################################################
SERVER_ADDRESS=0.0.0.0
SERVER_PORT=3000
SERVER_TIMEZONE=Asia/Jakarta
SECRET_KEY=
APP_ENVIRONMENT=development
APP_LOG=production

####################################################################
# SWAGGER CONFIGURATION
####################################################################
SWAGGER_SERVER_ADDRESS=http://localhost:3000

####################################################################
# AWS CONFIGURATION
####################################################################
AWS_ACCESS_KEY=
AWS_ACCESS_SECRET=
AWS_DYNAMO_TABLE=
KINESIS_STREAM_NAME=
KINESIS_SHARD_ID=
KINESIS_SHARD_TYPE=LATEST

####################################################################
# PROVIDER CONFIGURATION
####################################################################
SMS_ORDER_CONF=[{"provider":""},{"provider":""}]
EMAIL_ORDER_CONF=[{"provider":""},{"provider":""}]

####################################################################
# INFOBIP CONFIGURATION
####################################################################

INFOBIP_USERNAME=
INFOBIP_PASSWORD=
INFOBIP_SEND_SMS_URL=
INFOBIP_SENDER_ID=
INFOBIP_CALLBACK=
INFOBIP_SHARD_ID=
INFOBIP_SHARD_TYPE=LATEST

####################################################################
# WAVECELL CONFIGURATION
####################################################################
WAVECELL_ACC_ID=
WAVECELL_SUB_ACC_ID=
WAVECELL_ACC_TOKEN=
WAVECELL_SUB_ACC_ID_GENERAL=
WAVECELL_CALLBACK_URL=
WAVECELL_SHARD_ID=
WAVECELL_SHARD_TYPE=LATEST

####################################################################
# MAILTRAP CONFIGURATION
####################################################################
MAILTRAP_HOST=smtp.mailtrap.io
MAILTRAP_PORT=587
MAILTRAP_USERNAME=
MAILTRAP_PASSWORD=
MAILTRAP_IDENTITY=

####################################################################
# SENDGRID CONFIGURATION
####################################################################
SENDGRID_TOKEN=
SENDGRID_URL=https://api.sendgrid.com

####################################################################
# FCM CONFIGURATION
####################################################################
FCM_APIKEY=
FCM_SENDER_ID=

After environment setting then run your server

go run src/main.go

for building

go build src/main.go

Live Reload

To activate Live Reload install air

on macOS

curl -fLo /usr/local/bin/air \
    https://raw.githubusercontent.com/cosmtrek/air/master/bin/darwin/air
chmod +x /usr/local/bin/air

on Linux

curl -fLo /usr/local/bin/air \
    https://raw.githubusercontent.com/cosmtrek/air/master/bin/linux/air
chmod +x /usr/local/bin/air

on Windows

curl -fLo ~/air.exe \
    https://raw.githubusercontent.com/cosmtrek/air/master/bin/windows/air.exe

see watcher.conf setting watcher file for air config now

Starting Live Reload

go to your project path

air -c watcher.conf

Production Mode

Dockerizing

Building Image

docker build -t boiler

Edit Environment In docker-compose.yml then Run Compose

docker-compose up

Stop Container

docker-compose stop

Remove your container

docker-compose rm -f

How To Use

See the list below for instructions on how to use this boilerplate:

Entity are a form of modeling of the REST API that you will create
Repositories Is a connection model that you will use in a service that will be created later, the entity plays an important role for modeling data that will be stored in a database
Service Is a logic process that you will create services can also be combined with business logic to facilitate you in managing all services so pay attention to the layering version of the service
Controller an intermediary between routing and service controller regulates all input and input formats of the REST API that you will create
Routing Routing is a mapping of the paths of the REST API that you have designed, routing is available on each controller version layering, this routing will be called on the router that has been created

Plugins and utils are in the util folder all third-party packages that help you should be stored in this folder, you can choose whether the package is a middleware of your REST API or as a pure supporting utility

Documentation Format

Setup Swagger Docs

See Documentation Swag Docs

How To Contribute

Please refer to each project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull request so that we can review your changes