Cuckoo is an open source product directed to companies and work teams that use Slack to communicate. It focuses on storing your important Slack Posts in one place so that you don’t miss a thing.
- With Cuckoo you can create events or announcements that will be published on the platform's "Cuckoos feed" where you can find all the posts previously published by other members of your organisation.
- These posts will also be sent to a channel on your slack workspace, depending on their category. A reminder will also be sent 1 day before the event starts.
- Events will go into a collective calendar. This way you can quickly have access to what will be happening in the following days, so you don’t miss a thing.
$ git clone https://github.com/NestSI-21/cuckoo.git
- Go to api.slack and create a new App from scratch
- Call it Cuckoo and choose your workspace
- Go to Settings/Basic Information/App Credentials and look for the following information to add to the respective files:
In client/.env:
REACT_APP_SLACK_CLIENT_ID =
- Now, complete the file with the requested information:
REACT_APP_SLACK_REDIRECT_URL = https://yourFrontend.com/api/v1/auth/slack
REACT_APP_API_BASE_URL = http://localhost:8000 (to run it locally)
- Add the name of your organization
REACT_APP_ORGANIZATION_NAME =
In server/.env:
SLACK_CLIENT_ID =
SLACK_CLIENT_SECRET =
FRONTEND_HOST = https://yourFrontend.com
SLACK_OAUTH_TOKEN =
SLACK_API_TOKEN =
CUCKOOS_URL = cuckoos.io
SLACK_CLIENT_ID and SLACK_CLIENT_SECRET can be found on Basic Information/App Credentials.
To get these tokens (SLACK_OAUTH_TOKEN and SLACK_API_TOKEN) you need to install the App on your workspace.
For that, go to Settings/OAuth & Permissions and follow the next steps:
- Add a Redirect URL that should be something like: 'https://yourFrontend.com/api/v1/auth/slack'
- Insert the Bot and User Token Scopes specified below:
- Install the App on your Workspace by pressing the button
Now you can paste the generated tokens to the file server/.env:
SLACK_OAUTH_TOKEN = User OAuth Token
SLACK_API_TOKEN = Bot User OAuth Token
-
Setup
$ docker-compose build -
Run App
$ docker-compose up -
Update Gemfile with new gems and install those gems
$ docker-compose build
- Reminders for events/announcements (google calendar connection).
- Using the bot to create posts inside Slack and then posting them on the platform.
- Develop delete button and visual removal of a post.
- ...
Cuckoo is licensed under MIT. Refer to LICENSE.txt for more information.