https://github.com/webkom/event-reminder
🛎 Posts events opening today to Slack
https://github.com/webkom/event-reminder
hacktoberfest slack-bot
Last synced: 18 days ago
JSON representation
🛎 Posts events opening today to Slack
- Host: GitHub
- URL: https://github.com/webkom/event-reminder
- Owner: webkom
- License: mit
- Created: 2018-03-20T01:22:44.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-20T09:52:51.000Z (over 3 years ago)
- Last Synced: 2025-12-13T01:34:12.140Z (6 months ago)
- Topics: hacktoberfest, slack-bot
- Language: JavaScript
- Homepage:
- Size: 87.9 KB
- Stars: 2
- Watchers: 14
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# event-reminder [](https://ci.webkom.dev/webkom/event-reminder)
> Posts events opening today to Slack. Built as an example application for the [LEGO API](https://https://github.com/webkom/lego).
## Installation
event-reminder needs at least version 7.6 of Node.js, and
[yarn](https://yarnpkg.com/en/) installed.
```bash
$ yarn
```
## Usage
First you'll need to create an incoming webhook for use with Slack.
This is what the application uses to post the daily reminders, and you can
create one in your Slack's [integration settings](https://my.slack.com/services/new/incoming-webhook/).
To run without user authentication, the application can be started with:
```bash
$ WEBHOOK_URL=... WEBHOOK_URL_JOBLISTINGS=... yarn start
$ # To run requests against the real API instead of
$ # the staging version, set NODE_ENV=production as well.
```
If you want to authrorize using your own user, you need an OAuth2 application,
which can be created through your
[user profile](https://abakus.no/users/me/settings/oauth2).
This will give you a client ID, and a client secret. With that in hand, we can
retrieve our initial authorization token:
```bash
$ CLIENT_ID=... CLIENT_SECRET=... yarn token
$ # This should open a browser window where you can complete the OAuth2 sign-in
$ # process. After that is done you'll get an `ACCESS_TOKEN` and a `REFRESH_TOKEN`.
```
At this point you should have all the required environment variables:
* `ACCESS_TOKEN`
* `REFRESH_TOKEN`
* `CLIENT_ID`
* `CLIENT_SECRET`
* `WEBHOOK_URL`
The application can then be started with:
```bash
$ ACCESS_TOKEN=... REFRESH_TOKEN=... CLIENT_ID=... CLIENT_SECRET=... WEBHOOK_URL=... yarn start
```