Skip to content

Commit

Permalink
chore: add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Makcal committed Oct 15, 2024
1 parent 1a9c70c commit 543e6b0
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
# InNoHassle-RoomsBot
# Rooms Bot in InNoHassle ecosystem

## Development

### Getting started

1. Install Python 3.12

2. Install Poetry

3. Install dependencies
```bash
poetry install
```

4. Set up pre-commit hook
```bash
poetry run pre-commit install
```

5. Set up settings file.
```bash
cp example.env .env
```
Insert your bot token and API token (see [API's README](https://github.com/one-zero-eight/rooms/blob/main/README.md) to obtain it).
## Run
Run an [API](https://github.com/one-zero-eight/rooms/) instance.
Then, run the bot:
```bash
poetry run python -m src.bot.main
```

0 comments on commit 543e6b0

Please sign in to comment.