mic-bot/DEV-NOTES.md

14 lines
622 B
Markdown
Raw Permalink Normal View History

2024-10-19 10:31:17 +00:00
## Project dependencies
- `grammyX` Telegram JS/TS/Deno library
- `kysel` Helps with migrations and query building
- `node:pg` Library used by kysely by default
2024-10-19 10:00:35 +00:00
2024-10-19 10:31:17 +00:00
## Structure
2024-10-19 10:00:35 +00:00
- `bot` -- the bot code itself
- `cfg` -- everything configuration related
2024-10-19 10:31:17 +00:00
- `core` -- core or domain. Contains entity and logics, responsible for the access management, also containes core entities
2024-10-19 10:00:35 +00:00
- `external` -- eveything responsible for communication with an external network interfaces/devices
2024-10-19 10:31:17 +00:00
- `migrations` -- DB migrations
2024-10-19 10:00:35 +00:00
- `repo` -- everything storage related (including external databases, caches, CDNs)
- `utils` -- everything else