/telegramMRP

Telegram Message Run Processor

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

telegramMRP

Telegram Message Run Processor will allow you to send messages to a channel or group through a bot with light-markdown format.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  1. Install Docker on your machine, here is the link to Docker installation page (For Windows: Install Docker toolbox)

  2. Install Git

  3. To check that you are able to execute the code, you should be able to view a valid output from this command (run it on terminal):

    docker run hello-world
    
  4. Create a bot with instructions from Telegram API Bot and note down the key, you will need it for the config.php file. Also create a group or channel and add the bot as an admin. In order to obtain the channel_idfor the config.phpfile, follow these instructions.

Installing

  1. Git clone this repository to be able to work with the files included, and move to the directory on your system.

  2. config.php must be created before executing the script. There is a config_template.php to check possible values.

  3. The script expect the file message.mdto exists in the root path. Telegram API does not support full markdown, but we could use different aspects of it:

    *bold text*
    _italic text_
    [inline URL](http://www.example.com/)
    [inline mention of a user](tg://user?id=123456789)
    `inline fixed-width code`
    ```block_language
    pre-formatted fixed-width code block
    ```
    
  4. config.phpfile is ready to work with two envs, but you could use only one, just be sure to setup it correctly within index.php.

  5. Execute command:

    docker build -t telegram-mrp . && docker run -it --rm telegram-mrp
    
    

Deployment

TODO

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Andrés Velasco - Software Engineer

See also the list of contributors who participated in this project.

License

GPL 3.0