Otto-bot

module
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 14, 2023 License: MIT

README

basic-go-repo

Otto is a bot designed to help you stay up-to-date with the latest news by monitoring RSS feeds and sending notifications via Telegram.

This part of the code only contains the bot flow

Table of Contents

Getting Started

Prerequisites

Make sure you have the following tools installed on your machine:

  • Go (at least version 1.20)
  • A valid Telegram bot:
  • Setup an .env file
# Bot token given by the @BotFather
TELEGRAM_BOT_TOKEN=<TELEGRAM_BOT>

# OTTO api url to connect the bot with its api
OTTO_API_URL=<OTTO_API_URL>

Installing

To install Otto, run the following command:

make ensure_deps

Running Tests

To run tests, use the following command:

make test

Running Lint

To run lint, use the following command:

make lint

TIPS

To make sure it's easy to build, I use: gow. Once install:

make watch

Usage

To use Otto, run the following command:

make build && ./bin/bot

Contributing

Contributions are welcome! Please see the CONTRIBUTING.md file for more information.

License

This project is licensed under the LICENSE file in the root directory of this repository.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL