ImgBotApp / holiday_ping

Erlang/Cowboy + ClojureScript/re-frame + PostgreSQL application that sends holiday reminders via slack, mail, etc

Home Page:https://holidayping.lambdaclass.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Holiday Ping Build Status

Holiday ping is an Erlang/OTP application that allows users to send national holiday reminders through different channels (e.g. email, Slack).

Project setup for development

The project requires Elrang/OTP 20 and Leningen for the ClojureScript web application.

Setup the database (using Docker):

$ make ops

Create the tables:

$ make ops_start

Compile and run a development shell:

$ make dev

Run the tests:

$ make test

Build a release:

$ make release

UI setup

The UI is a ClojureScript project that uses re-frame. The code is in priv/ui and is build as part of the dev and release targets.

For UI development, run a dev shell and then:

$ make dev_ui

Which uses figwheel to provide a REPL and hot-reload of the code changes.

Production install

Inside the devops folder you can find an install shell script for installing holiday_ping in a debian 9 serer.

Credentials

GitHub login configuration

For the GitHub login option to work, OAuth cretentials need to be generated and set as GITHUB_CLIENTID and GITHUB_SECRET environment variables.

Amazon SES

To send emails with amazon, set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables. Also, make sure email_enabled is set to true in the application environment (e.g. in conf/dev.config).

Rest API Reference

Not yet.

About

Erlang/Cowboy + ClojureScript/re-frame + PostgreSQL application that sends holiday reminders via slack, mail, etc

https://holidayping.lambdaclass.com/

License:MIT License


Languages

Language:Erlang 50.6%Language:Clojure 47.8%Language:Shell 1.0%Language:Makefile 0.6%