crapaud-fou/coabot
2
0
Fork 0
Code Issues Pull requests Releases Activity
Un bot rocketchat pour les crapauds fous.
15 commits 1 branch 1 tag 131 KiB
JavaScript 64.6%
Shell 31.6%
Dockerfile 3.5%
Batchfile 0.3%
Find a file
mose 64db9d65b2 right name for individous
2019-09-15 15:34:08 +08:00
bin initial code in state marchote 2019-09-12 17:02:55 +08:00
img initial code in state marchote 2019-09-12 17:02:55 +08:00
src right name for individous 2019-09-15 15:34:08 +08:00
.env.example initial code in state marchote 2019-09-12 17:02:55 +08:00
.gitignore initial code in state marchote 2019-09-12 17:02:55 +08:00
Dockerfile initial code in state marchote 2019-09-12 17:02:55 +08:00
index.js put reactions before url_metadata to inhibit facebook links discovery 2019-09-15 08:30:30 +08:00
init.js initial code in state marchote 2019-09-12 17:02:55 +08:00
LICENSE initial code in state marchote 2019-09-12 17:02:55 +08:00
package.json initial code in state marchote 2019-09-12 17:02:55 +08:00
README.md initial code in state marchote 2019-09-12 17:02:55 +08:00
yarn.lock initial code in state marchote 2019-09-12 17:02:55 +08:00

README.md

bRocket | A bBot boilerplate for Rocket.Chat bots

Setup

1. 🍴 Fork or clone this repo

  • git clone amazebot/bbot-rocketchat-boilerplate MY_BOT
  • to clone without git history, add --depth 1 flag
  • or once cloned, start a fresh history rm -rf .git && git init

2. 💻 Setup your project

  • npm install get dependencies
  • npm run setup add your details

3. ✨ Test in shell

  • npm start -- -m shell

4. 👨‍💻 Start coding

  • customise index.js
  • look at examples.js

5. 💬 Run in Rocket.Chat

  • create user with bot role
  • set login credentials in .env
  • npm start (rocketchat is default adapter)

You'll need a Rocket.Chat instance to test. See Rocket.Chat's docs on Creating Bot Users before you begin.

Easy deployment options coming soon.

See bbot.chat for get started guides.

Configure

All bBot settings require the BOT_ prefix on environment variables.

See Rocket.Chat's docs on Configuring Bot Environments for settings specific to the SDK.

Configs can be given from command line. Try node index.js -h for options.

They can also be set in package.json under the "bot" attribute. You should review all the package details and customise it to your own project details.

Development

You can run and interact with the bot directly in shell, for quick development.

Run node index.js -m shell to override Rocket.Chat as the message adapter.