https://github.com/maxbarsukov/kamilbot

🥺👉👈 A bot replacing Kamil (https://t.me/kamilonly) during his absence from ITMO chats
https://github.com/maxbarsukov/kamilbot

kamilonly logovo-bazirovannih node-telegram-bot-api telegram-bot

Last synced: about 2 months ago
JSON representation

🥺👉👈 A bot replacing Kamil (https://t.me/kamilonly) during his absence from ITMO chats

• Host: GitHub
• URL: https://github.com/maxbarsukov/kamilbot
• Owner: maxbarsukov
• License: mit
• Created: 2023-03-19T12:15:52.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-16T00:56:13.000Z (7 months ago)
• Last Synced: 2024-11-01T15:37:06.027Z (2 months ago)
• Topics: kamilonly, logovo-bazirovannih, node-telegram-bot-api, telegram-bot
• Language: TypeScript
• Homepage: https://github.com/pro100kamil
• Size: 705 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Kamil Bot

[![docker](https://github.com/maxbarsukov/kamilbot/actions/workflows/docker.yml/badge.svg)](https://github.com/maxbarsukov/kamilbot/actions/workflows/docker.yml)

![license](https://img.shields.io/badge/license-MIT-green)

English ｜ [Русский](README.ru.md)

[![moment 1](./docs/img/kamil3.jpg)](./docs/img/kamil3.jpg)

[![moment 2](./docs/img/kamil4.jpg)](./docs/img/kamil4.jpg)

> Покорми меня 🥺 by [Камиль](https://t.me/kamilonly)

## Table of contents

1. [Updates](#updates)

2. [Getting Started](#getting-started)

   1. [Pre-reqs](#pre-reqs)

   2. [Building and Running](#run)

3. [Linting](#linting)

4. [Contributing](#contributing)

5. [Code of Conduct](#code-of-conduct)

6. [License](#license)

## Updates 

🎉 v2 has been released!

  🔔 Jul. 2, 2023 (v0.3.0)

> - Add nylon logging. Literally 1984.

  🔔 Mar. 24, 2023 (v0.2.0)

> - Fix some bugs, update random messages.

🎉 v1 has been released!

  🔔 Mar. 20, 2023 (v0.1.0)

> - Create bot, add basic names and name detector.

## Getting Started 

### Pre-reqs 

Make sure you have [`git`](https://git-scm.com/) installed.

To build and run this app locally you will need a few things:

- Check you have [Node.js](https://nodejs.org/en) installed *(tested with **v18.12.1**)*;

- Install [Yarn](https://yarnpkg.com/) *(tested with **1.22.19**)*;

***or***

- Install [Docker](https://docs.docker.com/);

- Install [docker-compose](https://docs.docker.com/compose/install/);

Clone this repository:

    git clone [email protected]:maxbarsukov/kamilbot.git

### Building and Running 

#### Locally

    yarn install

    yarn build

    yarn start

#### Docker

    ./bin/docker-setup

    docker-compose up

## Linting 

### Locally

```bash

yarn lint # yarn lint:fix to fix with eslint

yarn format # yarn format:fix to fix with prettier

```

### Docker

Run `bin/docker-setup` and `bin/docker-quality` to launch quality checkers in Docker;

## Contributing 

Bug reports and pull requests are welcome on GitHub at https://github.com/maxbarsukov/kamilbot.

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/maxbarsukov/kamilbot/blob/master/CODE_OF_CONDUCT.md).

## Code of Conduct 

Everyone interacting in the **kamilbot** project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/maxbarsukov/kamilbot/blob/master/CODE_OF_CONDUCT.md).

## License 

The project is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

*Copyright 2023 Max Barsukov*

**Leave a star :star: if you find this project useful.**