Telegram RaF [Refer a Friend](@RefafBot)

RaF is a bot for creating referral-based contests for your Telegram channels, groups and supergroups.

Create contests, let your users share their link to your channel/group, increase your audience, and give prizes to the winners!

Introduction

The software is written in rust. Raf depends on a fork of telexide, a rust library for making telegram bots. The fork makes the original library work and solves some issues.

The storage used is SQLite: RaF creates a raf.db file in its run path where it saves all the relationships between:

• Who owns the channels
• The contests created
• The invitations each participant generated
• The users who joined the channel through an invitation

Setup

1. Install RaF

For the development version:

bash cargo install --path .

For the production version:

bash cargo install telegram-raf

1. Create the run path and the environment file

```bash mkdir $HOME/.raf

echo 'BOT_NAME=""' > $HOME/.raf/raf.env echo 'TOKEN=""' >> $HOME/.raf/raf.env ```

1. Copy the systemd service file

bash sudo cp misc/systemd/raf@.service /lib/systemd/system/

1. Start and enable the service

bash sudo systemctl start raf@$USER.service sudo systemctl enable raf@$USER.service

The raf.db (to backup or inspect) is in $HOME/.raf/.

Contributing

Any feedback is welcome. Feel free to open issues and create pull requests!

License

``` Copyright 2021 Paolo Galeone nessuno@nerdz.eu

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ```