ghee-boilerplate
Advanced tools
This is a boilerplate setup for a ghee Slack bot.
For more information on how to use ghee, please visit the ghee wiki.
Clone this repo or install via yarn/npm:
$ npm install ghee-boilerplate
Go to your Custom Integrations page for your Slack instance and set up a new Bot integration. Copy the API token and save for later.
If running locally, copy .env-sample to .env and add your Slack API token to
the .env file.
If running on a server, you can set the SLACK_API_TOKEN to the value of the
Slack API token.
If running on a hosted service such as Heroku, you can set the Config Variables on your apps Settings page.
Run yarn install if you have just cloned the repo for the first time, to
install the required dependencies.
Run yarn start to start the bot.
The bot will now join your Slack instance if you specified the correct API token. You can invite the bot to whatever channel you want it to be present in.
Since this is a boilerplate, the bot will not respond to any commands. Please see the ghee wiki or view the ghee sample bot for more information on how to use this boilerplate.
You can quickly run the boilerplate bot via Heroku. Clicking this button will take you to Heroku, where you will be able to enter your Slack API token and launch the bot on a single worker dyno.
FAQs
A boilerplate to build your Slack Bot using ghee
The npm package ghee-boilerplate receives a total of 1 weekly downloads. As such, ghee-boilerplate popularity was classified as not popular.
We found that ghee-boilerplate demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.