Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lambdaclass/holiday_pinger
Erlang + ClojureScript app to send holiday reminders
https://github.com/lambdaclass/holiday_pinger
clojurescript erlang freelance holidays mail ping postgresql reminders slack
Last synced: about 1 month ago
JSON representation
Erlang + ClojureScript app to send holiday reminders
- Host: GitHub
- URL: https://github.com/lambdaclass/holiday_pinger
- Owner: lambdaclass
- License: mit
- Created: 2017-06-22T18:44:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-10-21T14:00:32.000Z (about 4 years ago)
- Last Synced: 2024-04-02T10:30:29.626Z (9 months ago)
- Topics: clojurescript, erlang, freelance, holidays, mail, ping, postgresql, reminders, slack
- Language: Erlang
- Homepage: https://holidaypinger.com
- Size: 4.36 MB
- Stars: 69
- Watchers: 25
- Forks: 9
- Open Issues: 93
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Holiday Pinger [](https://travis-ci.org/lambdaclass/holiday_pinger)
Holiday Pinger 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](https://github.com/Day8/re-frame).
The code is in [priv/ui](https://github.com/lambdaclass/holiday_ping/tree/master/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](devops/sh/install.sh) for installing holiday_ping in a debian 9 server. On the other hand, you can do `make app_image` to generate a Docker image of HolidayPinger called `holiday-ping`.
The release generated for `prod` expects some config values from the environment. If you prefer, you can modify [prod.config](conf/prod.config) to directly set the values and re-make the release or image. The expected environment variables are this:
- `RELX_REPLACE_OS_VARS=true`
- `SSL_CERTFILE=`
- `SSL_KEYFILE=`
- `TOKEN_SECRET=`
- `POSTGRES_HOST=`
- `POSTGRES_USER=`
- `POSTGRES_PASSWORD=`
- `POSTGRES_DB=`
**NOTE:** Remember to mount the folder where `SSL_CERTFILE` and `SSL_KEYFILE` are stored into the container.
### Credentials
#### GitHub and Google login configuration
For the GitHub login option to work, [OAuth cretentials](https://github.com/settings/applications/new)
need to be generated and set as `GITHUB_CLIENTID` and `GITHUB_SECRET`
environment variables.
Similarly, use the [Google developers console](https://console.developers.google.com/) to generate the Google credentials and set them as `GOOGLE_CLIENTID` and `GOOGLE_SECRET`.
### Email providers
Holiday Pinger supports two different providers for sending emails: Amazon SES and Mailgun. To choose one, set it in the config file (`prod.conf` for the production environment) as
```
{email_provider, erlcloud_ses}
```
for Amazon SES and
```
{email_provider, mailgun}
```
for Mailgun. Afterwards, make sure `email_enabled` is set to true in the
application environment (e.g. in conf/dev.config) and then supply the appropiate environment variables:
#### Amazon SES
To send emails with amazon, set `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
#### Mailgun
To send emails with Mailgun, set `MAILGUN_KEY` and `MAILGUN_DOMAIN`.
## Rest API Reference
Not yet.