Kamil Bot

English ｜ Русский

Покорми меня 🥺 by Камиль

Table of contents

1. Updates
2. Getting Started
   1. Pre-reqs
   2. Building and Running
3. Linting
4. Contributing
5. Code of Conduct
6. License

Updates

🎉 v2 has been released!

• Add nylon logging. Literally 1984.

• Fix some bugs, update random messages.

🎉 v1 has been released!

• Create bot, add basic names and name detector.

Getting Started

Pre-reqs

Make sure you have git installed.

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

• Check you have Node.js installed (tested with v18.12.1);
• Install Yarn (tested with 1.22.19);

or

• Install Docker;
• Install docker-compose;

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

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.

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.

License

The project is available as open source under the terms of the MIT License. Copyright 2023 Max Barsukov

Leave a star ⭐ if you find this project useful.