Skip to content

Commit

Permalink
Merge pull request #9 from maybenotilya/dev
Browse files Browse the repository at this point in the history
Fix run instructions in README and add example of .env file
  • Loading branch information
NikitosKey authored Dec 21, 2024
2 parents c59f3ea + f54004c commit 14f2a76
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
BOT_TOKEN=<YOUR BOT TOKEN>
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,24 +100,27 @@ pip install -r requirements.txt
export BOT_TOKEN=your_token

# Run the bot
poetry run python bot/__main__.py
poetry run python -m bot.__main__

# For convenience, you can use screen or tmux to keep the bot running in the background:

# Using screen
screen -S alcounting_bot
poetry run python bot/__main__.py
poetry run python -m bot.__main__

# Using tmux
tmux new -s alcounting_bot
poetry run python bot/__main__.py
poetry run python -m bot.__main__
```

That's it!
The bot will now run in the background, processing user requests.
To stop the bot, press `Ctrl+C`.

##### Local Installation Docker-Compose Method

##### Local Installation Docker Method
Firstly, you need to create `.env` file. You can find example in `.env.example`.

```shell
# Install Docker and Docker Compose from https://docs.docker.com/get-docker/ and https://docs.docker.com/compose/install/ if you haven't already.
docker-compose up --build
Expand Down

0 comments on commit 14f2a76

Please sign in to comment.