Kruhlmann/gatekeeper

# Gatekeeper discord bot

[![Discord Server](https://img.shields.io/discord/572880907682447380%20.svg?logo=discord&style=for-the-badge)](https://discord.gg/Y5eA3dW)
[![Build Status](https://img.shields.io/github/workflow/status/kruhlmann/gatekeeper/node?style=for-the-badge)](https://github.com/Kruhlmann/gatekeeper/actions)
[![Maintainability](https://img.shields.io/codeclimate/maintainability/Kruhlmann/gatekeeper.svg?style=for-the-badge)](https://codeclimate.com/github/Kruhlmann/gatekeeper/maintainability)

## Setup

<p align="center">
  <a href="https://discordapp.com/oauth2/authorize?client_id=660177114846199808&scope=bot&permissions=268435456">
    <img src="doc/connect.png" />
  </a>
</p>

To invite the bot click [this link](https://discordapp.com/oauth2/authorize?client_id=660177114846199808&scope=bot&permissions=268435456) (or the image above) as the server owner. Invite the bot to the server of your choice and, if necessary, promote it to allow for administrative tasks.

## Usage

### Local setup

#### Dependencies

If you want to run your own instance of the bot the following packages are required:

* gcc
* autoconf
* libtool
* build-essential
* make
* automake
* nodejs >=10.16.0
* yarn
* postgres >=11.5
* node-pg-migrate
* pg

Make sure to create the gatekeeper database and run the migration to create the tables.

```
postgres=# CREATE DATABASE gatekeeper;
CREATE DATABASE
postgres=# \q
```


```bash
git clone https://github.com/Kruhlmann/gatekeeper
cd gatekeeper
yarn install
yarn run upgrade
```

You must rename [config.json.example](config.json.example) to `config.json` and fill it in with the required details.

#### Environment variables

* `GATEKEEPER_DB_USR` postgres database user
* `GATEKEEPER_DB_PWD` postgres database user password
* `GATEKEEPER_DB_NAM` postgres database name
* `GATEKEEPER_DISCORD_TOKEN` [discord API token](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)