-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |