fatmalabidi/MailBoxServcie

MailboxService

Mailbox service is responsible for all the in-app messaging and notifications

configuration

use CONFIGOR_ENV environment variable to specify which config to use. available configs are

1. config.dev.yml for development environment
2. confif.test.yml for the test environment
3. confif.prod.yml for the production environment please refer to template file to see the available field for configuration

build locally

1. download the dependencies

   make init

2. run the tests

     make test

3. generate test coverage badge

    gopherbadger -md="README.md"

4. run test coverage and generate coverage report in html page

    make coverage

5. build the server executable:

   please note that the default configuration is for Production environment.

• for test or dev environment, set the variable CONFIGOR_ENV to test :

      CONFIGOR_ENV=test make build-server

• for production environment:

    make build-server  

build docker container

Before building docker container you need to export the following variables and refer to Makefile for docker related commands

export export GITHUB_USER=[github-username]
# this can be created from your personal account -> Developer settings -> personal access token
# this token should be read for repos and that's it 
export export GITHUB_TOKEN=[github-user-token] 
# AWS Stuff
# you can get them from ~/.aws/credentials
export AWS_ACCESS_KEY_ID=[aws_access_key_id]
export AWS_SECRET_ACCESS_KEY=[aws_secret_access_key]
export AWS_DEFAULT_REGION=eu-west-1