profitroll
7c5dd326bd
All checks were successful
Tests / test (3.10) (push) Successful in 9s
Tests / test (3.11) (push) Successful in 8s
Tests / test (3.9) (push) Successful in 8s
Tests / test (3.10) (pull_request) Successful in 9s
Tests / test (3.11) (pull_request) Successful in 9s
Tests / test (3.9) (pull_request) Successful in 9s
28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
# Welcome to Garbage Reminder
|
|
|
|
Universal, easy to set up and maintain way to remind your family, your neighbors or your tenants about garbage collection.
|
|
Built with Python using FastAPI, Pyrogram, MkDocs Material and in the future also Pycord.
|
|
|
|
## How it works
|
|
|
|
The whole instance consist of an API and the clients.
|
|
We provide chatbots as clients. These bots provide the access to the data stored in the database of an API.
|
|
|
|
## Why this exists
|
|
|
|
After seeing that most cities and villages around only offer proprietary software/websites or even no digital information
|
|
about garbage collection at all, it was decided to develop an own solution to this problem by storing the data in a
|
|
database and then show the data the way it is helpful for the end-user.
|
|
|
|
## Deployment
|
|
|
|
Bare minimum installation requires a database and an API. Then you can use any way you like to connect to the API.
|
|
We provide Telegram bot and raw HTTP for that now, but Discord bot and CLI are planned too.
|
|
|
|
Here is how the "normal" deployment process looks like:
|
|
|
|
1. Install the requirements [[API](api/installation.md#requirements)/[Telegram](bot_telegram/installation.md#requirements)]
|
|
2. Install the API server [[Guide](api/installation.md)]
|
|
3. Install the client/bot of your linking [[Telegram](bot_telegram/installation.md)]
|
|
4. Fill the API/bot with the data [[API](api/feeding-data.md)/[Telegram](bot_telegram/feeding-data.md)]
|