added production and build instructions

This commit is contained in:
Shihaam Abdul Rahman 2023-04-09 21:05:20 +05:00
parent 5b4666edc3
commit 4de1f643eb
Signed by: shihaam
GPG Key ID: 6DA2E87EBC227636

View File

@ -3,16 +3,22 @@
A Telegram bot that lets you interact with the Bing AI from chats that you allow in the config. A Telegram bot that lets you interact with the Bing AI from chats that you allow in the config.
**> To start using this project,** **> To start using this project,**
- Git clone and cd into cloned dir
- Run `yarn install` to install the dependencies. - Run `yarn install` to install the dependencies.
- Create a `.env` file or set environment variables according to the reference file `.env.example` - Create a `.env` file or set environment variables according to the reference file `.env.example`
- Run `yarn dev` or `yarn build && yarn start` to start the bot. - Run `yarn dev` or `yarn build && yarn start` to start the bot.
**> To start using this project using Docker,** **> To start using this project using Docker,**
- Git clone and cd into cloned dir
- Run `docker compose -f .build/docker-compose.yml build` to build the container - Run `docker compose -f .build/docker-compose.yml build` to build the container.
- Create a `.env` file or set environment variables according to the reference file `.env.example` - Create a `.env` file or set environment variables according to the reference file `.env.example`
- Run `docker compose up -d` to start the bot. - Run `docker compose up -d` to start the bot.
- Run `docker compose -f .build/docker-compose.yml push` to push container to registry.
**> To start using this project using Docker in prod**
- Create `docker-compose.yml` with the content from `docker-compose.yml` in repo.
- Create `.env` with the required variables. (see .env.example in repo)
- Run `docker compose up -d` to start the bot.
**> To enable Telegram command autocompletion,** **> To enable Telegram command autocompletion,**