Installation

Getting started

Before you get started, make sure you have installed and configured Git on your local machine.

Installation

1. Open your command line interface (CLI).

2. Download the latest release or clone this repository to your local machine.

$ git clone https://github.com/zulip/zulipbot.git

3. Switch to the local copy of this repository.

$ cd ~/path-to-repo/zulipbot

4. Install the necessary node packages and dependencies.

$ npm install

Configuration

4. Create two files in the src folder: one file named config.js, the other named secrets.js.

$ touch src/config.js
$ touch src/secrets.js

5. Run the bot to ensure that your environment was configured correctly.

$ npm start

Collaborate with zulipbot

1. Invite @zulipbot to collaborate on your organization's repository.
2. Change @zulipbot's permission level in the repository to Admin.
3. Finally, add the zulipbot integration to your repository.