Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ashokshau/assistant

bot to chat with user, like a livegrambot
https://github.com/ashokshau/assistant

bot go gotgbot livegram-bot mongo mongodb ptb python python-telegram-bot telegram telegram-bot

Last synced: 1 day ago
JSON representation

bot to chat with user, like a livegrambot

Awesome Lists containing this project

README

        

# Tg Assistant
- A Telegram bot to chat with users.
- It can be used to send messages, images, and files to users and users to bot owner.

## Prerequisites
- Go version 1.23 or higher
- A Telegram bot token, which can be obtained by talking to [BotFather](https://core.telegram.org/bots#botfather)

## Installation

### 1. Install Go:
- Follow the instructions to install Go on your system: [Go Installation Guide](https://golang.org/doc/install)

Easy Way:

```shell
git clone https://github.com/udhos/update-golang dlgo && cd dlgo && sudo ./update-golang.sh && source /etc/profile.d/golang_path.sh
```

Exit the terminal and open the terminal to check the installation.

Verify the installation by running:

```shell
go version
```

### 2. Clone the repository:

```shell
git clone https://github.com/AshokShau/Assistant && cd Assistant
```

### 3. Set up the environment

Copy the sample environment file and edit it as needed:

```shell
cp sample.env .env
vi .env
```

### 4. Build the project

```shell
go build
```

### 5. Run the project

```shell
./Assistant
```

## Contributing

Contributing Guidelines

Contributions are welcome! Follow these steps to contribute:

1. **Fork the repository**: Click the "Fork" button at the top right of this page to create a copy of this repository in
your GitHub account.

2. **Clone the repository**: Clone your forked repository to your local machine.
```shell
git clone https://github.com/your-username/Assistant.git
cd Assistant
```

3. **Create a branch**: Create a new branch for your changes.
```shell
git checkout -b feature-branch
```

4. **Make your changes**: Make your changes to the codebase.

5. **Commit your changes**: Commit your changes with a descriptive commit message.
```shell
git add .
git commit -m "Description of your changes"
```

6. **Push to your branch**: Push your changes to your forked repository.
```shell
git push origin feature-branch
```

7. **Submit a pull request**: Go to the original repository on GitHub and create a pull request from your forked
repository.

Please ensure your code follows the project's coding standards and includes appropriate tests.

Thank you for contributing!

## License

This project is licensed under the MIT License—see the [LICENSE](/LICENSE) file for details.

## Contact
[![Telegram](https://img.shields.io/badge/Telegram-Channel-blue.svg)](https://t.me/FallenProjects)
[![Telegram](https://img.shields.io/badge/Telegram-Chat-blue.svg)](https://t.me/AshokShau)