30 lines
No EOL
698 B
Markdown
30 lines
No EOL
698 B
Markdown
# About
|
|
This project: Telegram bot for displaying schedule for groups of students
|
|
Validate and run project via `uv`
|
|
|
|
### Commit message rules:
|
|
`{fix|add|impl|bot|event|web|any other...}: {message}`
|
|
|
|
# Folders:
|
|
## `./events/`
|
|
Separate event system implementation, i.e.: notifications about upcoming lessons
|
|
|
|
## `./bot/`
|
|
Main interactions with bot
|
|
|
|
## `./models/`
|
|
Main implementations
|
|
|
|
## `./web/`
|
|
Folder for static web content
|
|
|
|
## `./utils/schedule_client.py`
|
|
Main schedule database client to communicate with. Autogenerated from private repo, don't modify
|
|
|
|
# How to run
|
|
Copy `./config.example.py` to `./config.py`
|
|
Fill all variables in `./config.py`
|
|
Run via `uv run main.py`
|
|
|
|
|
|
...anything else??? |