📅 gcal

Easily view and manage Google Calendar events from your Elixir / Phoenix App.

Why? 🤷‍♀️

After building our calendar prototype that allowed us to visualize our Google Calendar events in a more friendly interface, we realized that much of the code could be reused. So we decided to split the code out into an independently tested, documented and maintained package that anyone can use.

What? 🗓️

A tiny well-documented, tested & maintained Elixir library for interacting with Google Calendar.

See it in action: github.com/dwyl/calendar

Who?

gcal is by us for us (@dwyl). We are using it in our calendar and MVP. Anyone else that needs to interact with Google Calendar from their Elixir / Phoenix App(s) is very welcome to use it.

If you like what you see, please star the repo. ⭐ 🙏
If you have any questions or suggestions, please open an issue we love hearing from people. 💬

How?

The package is available at: hex.pm/packages/gcal

Installation

Add gcal to your list of dependencies in mix.exs:

def deps do
  [
    {:gcal, "~> 1.0.3"}
  ]
end

Configuration

If you want to run tests with mocks in your project that uses Gcal, add the following lines to your config/text.exs file:

config :gcal,
  httpoison_mock: true

Usage

Google Auth Session access_token

This package expects a valid Google session access_token as the first argument for all functions. The easiest way to get a access_token is to use elixir-auth-google to allow people using your app to easily authenticate with their Google Account.

Functions

Please see: hexdocs.pm/gcal/Gcal.html#functions for the latest function reference.

Docs

Comprehensive documentation is available at: hexdocs.pm/gcal