Otto

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 API with the gestion of the PostGreSQL DB

Getting Started
Usage
Contributing
License

Getting Started

To get started with Otto, clone the repository to your local machine:

git clone https://github.com/Vico1993/Otto.git
cd Otto

Prerequisites

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

Go (at least version 1.20)
A valid Telegram bot:
- look at the great bot father
Setup an .env file

# Bot token given by the @BotFather
TELEGRAM_BOT_TOKEN=<TELEGRAM_BOT>

#DATABASE postgreSQL url ex:postgresql://username:password@url/db
DB_URI=<URI>

# GIN if you want to override port for the api, by default 8080
PORT=8888

Installing

To install Otto, run the following command:

make ensure_deps

Running Tests

To run tests, use the following command:

make test

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.

Vico1993/Otto