dev_guide.md

Table of Contents generated with DocToc

• Developer Guide
  • How to run in development mode?
  • Run Tests
  • Format Files
  • Linting Code
  • Build and Push the Docker Image
  • Integrating with Google Calendar API

Developer Guide

How to run in development mode?

Here's how you can run in development mode:

cd reminder/

# way 1
go run ./cmd/reminder

# way 2
cd cmd/reminder
go run .

# way 3
make -s run

Run Tests

You can make use of go_test to run test suite:

cd reminder/

# run tests while supressing printing to console
. ./scripts/go_test

# run tests without supressing printing to console
CONSOLE_PRINT=true . ./scripts/go_test

# or, using make (versbose)
CONSOLE_PRINT=true make test
# or, using make (don't echo commands, and print statements)
make -s test

Format Files

You can make use of go_fmt to auto-format all .go files:

cd reminder/

. ./scripts/go_fmt

# or using make
make -s fmt

Linting Code

make -s lint

Build and Push the Docker Image

Make use of build_image.sh to build and push (requires admin rights) Docker image:

# cd into repo
cd reminder/

# example, setting version
VERSION=v1.0.0

# building images and pushing them
. ./scripts/build_image.sh ${VERSION}

Integrating with Google Calendar API

Refer:

• Setting up the environment for Google Calendar Sync
• Go Quickstart
• pkg calendar
• Calendar API Reference