calendar-service

command module
v1.0.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 3, 2018 License: MIT Imports: 16 Imported by: 0

README

calendar-service Circle CI

A microservice to return Google calendar events in JSON format.

Download the latest release for your platform here

Starting and testing the service

To start the service, just run calendar-service.

If you need help, just run calendar-service --help.

There are a few command line parameters available:

Parameter Description
authEmail The OAuth 2.0 service account email address, as listed in your project in the Google Developer's console
authSubject The email address to impersonate. The request will be made on behalf of this account, so you need ownership of this user account
keyFile The location of the PEM encoded keyfile to authenticate your service account
port The port the service listens on.
allowedOrigins comma seperated list of CORS origins to allow. In order to access the service directly from a javascript application, you'll need to specify the origin you'll be running the javascript site on. For example: http://www.myjavascriptapplication.com

Once the service is up and running, you can connect to it using http://yourdomain.com:3000/calendar/calendarid where calendarid is the Google calendar id you'd like information for.

Example: http://yourdomain:3000/calendar/mg2l41ag8ua062trmktgdq6v90@group.calendar.google.com

To test your service quickly, you can use the Postman Google Chrome Extension to call the service and see the JSON return format.

Calendar information will be returned as a JSON payload outlined on the Google Calendar developer website.

Building
Prerequisites

To build, make sure you have the latest version of Go installed. If you've never used Go before, it's a quick install and there are installers for multiple platforms, including Windows, Linux and OSX.

Quick Start

Run the following commands to get latest and build.

go get github.com/danesparza/calendar-service
go build

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL